Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 8FCCB200CC2 for ; Tue, 20 Jun 2017 17:57:35 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 8EA30160BFC; Tue, 20 Jun 2017 15:57:35 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 87FDB160BFE for ; Tue, 20 Jun 2017 17:57:33 +0200 (CEST) Received: (qmail 93576 invoked by uid 500); 20 Jun 2017 15:57:32 -0000 Mailing-List: contact commits-help@jspwiki.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jspwiki.apache.org Delivered-To: mailing list commits@jspwiki.apache.org Received: (qmail 92977 invoked by uid 99); 20 Jun 2017 15:57:31 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 20 Jun 2017 15:57:31 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 566B5DFF2D; Tue, 20 Jun 2017 15:57:27 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: juanpablo@apache.org To: commits@jspwiki.apache.org Date: Tue, 20 Jun 2017 15:58:09 -0000 Message-Id: <0d7792914ddb406f993b51fceb2b15b8@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [44/51] [partial] jspwiki-site git commit: it is not mandatory to have the website under content; deleting it so the site can be generated from jbake branch archived-at: Tue, 20 Jun 2017 15:57:35 -0000 http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/8ce6b763/content/apidocs/2.10.1/org/apache/wiki/PageLock.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/PageLock.html b/content/apidocs/2.10.1/org/apache/wiki/PageLock.html deleted file mode 100755 index a456c70..0000000 --- a/content/apidocs/2.10.1/org/apache/wiki/PageLock.html +++ /dev/null @@ -1,389 +0,0 @@ - - - - - - - -PageLock (Apache JSPWiki Main War 2.10.1 API) - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -org.apache.wiki -
-Class PageLock

-
-java.lang.Object
-  extended by org.apache.wiki.PageLock
-
-
-
All Implemented Interfaces:
Serializable
-
-
-
-
public class PageLock
extends Object
implements Serializable
- - - - - -
- -

-Describes a lock acquired by an user on a page. For the most part, - the regular developer does not have to instantiate this class. -

- The PageLock keeps no reference to a WikiPage because otherwise it could - keep a reference to a page for a long time. -

- -

-

-
See Also:
Serialized Form
-
- -

- - - - - - - - - - - -
-Constructor Summary
PageLock(WikiPage page, - String locker, - Date acquired, - Date expiry) - -
-          Creates a new PageLock.
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- DategetAcquisitionTime() - -
-          Returns the timestamp on which this lock was acquired.
- DategetExpiryTime() - -
-          Returns the timestamp on which this lock will expire.
- StringgetLocker() - -
-          Returns the locker name.
- StringgetPage() - -
-          Returns the name of the page which is locked.
- longgetTimeLeft() - -
-          Returns the amount of time left in minutes, rounded up to the nearest - minute (so you get a zero only at the last minute).
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-PageLock

-
-public PageLock(WikiPage page,
-                String locker,
-                Date acquired,
-                Date expiry)
-
-
Creates a new PageLock. The lock is not attached to any objects at this point. -

-

-
Parameters:
page - WikiPage which is locked.
locker - The username who locked this page (for display purposes).
acquired - The timestamp when the lock is acquired
expiry - The timestamp when the lock expires.
-
- - - - - - - - -
-Method Detail
- -

-getPage

-
-public String getPage()
-
-
Returns the name of the page which is locked. -

-

-
-
-
- -
Returns:
The name of the page.
-
-
-
- -

-getLocker

-
-public String getLocker()
-
-
Returns the locker name. -

-

-
-
-
- -
Returns:
The name of the locker.
-
-
-
- -

-getAcquisitionTime

-
-public Date getAcquisitionTime()
-
-
Returns the timestamp on which this lock was acquired. -

-

-
-
-
- -
Returns:
The acquisition time.
-
-
-
- -

-getExpiryTime

-
-public Date getExpiryTime()
-
-
Returns the timestamp on which this lock will expire. -

-

-
-
-
- -
Returns:
The expiry date.
-
-
-
- -

-getTimeLeft

-
-public long getTimeLeft()
-
-
Returns the amount of time left in minutes, rounded up to the nearest - minute (so you get a zero only at the last minute). -

-

-
-
-
- -
Returns:
Time left in minutes.
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
-Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. - - http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/8ce6b763/content/apidocs/2.10.1/org/apache/wiki/PageLock.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/PageLock.png b/content/apidocs/2.10.1/org/apache/wiki/PageLock.png deleted file mode 100755 index e52ca94..0000000 Binary files a/content/apidocs/2.10.1/org/apache/wiki/PageLock.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/8ce6b763/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.html b/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.html deleted file mode 100755 index 312f9ff..0000000 --- a/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - -PageManager.PreSaveWikiPageTask (Apache JSPWiki Main War 2.10.1 API) - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -org.apache.wiki -
-Class PageManager.PreSaveWikiPageTask

-
-java.lang.Object
-  extended by org.apache.wiki.workflow.AbstractStep
-      extended by org.apache.wiki.workflow.Task
-          extended by org.apache.wiki.PageManager.PreSaveWikiPageTask
-
-
-
All Implemented Interfaces:
Serializable, Step
-
-
-
Enclosing class:
PageManager
-
-
-
-
public static class PageManager.PreSaveWikiPageTask
extends Task
- - - - - -
- -

-Inner class that handles the page pre-save actions. If the proposed page - text is the same as the current version, the execute() method - returns Outcome.STEP_ABORT. Any - WikiExceptions thrown by page filters will be re-thrown, and the workflow - will abort. -

- -

-

-
See Also:
Serialized Form
-
- -

- - - - - - - - - - - -
-Constructor Summary
PageManager.PreSaveWikiPageTask(WikiContext context, - String proposedText) - -
-          Creates the task.
-  - - - - - - - - - - - -
-Method Summary
- Outcomeexecute() - -
-           - Executes the processing for this Step and returns an Outcome indicating - if it succeeded (Outcome.STEP_COMPLETE or - Outcome.STEP_ABORT).
-  - - - - - - - -
Methods inherited from class org.apache.wiki.workflow.Task
getActor, getSuccessor, setSuccessor
-  - - - - - - - -
Methods inherited from class org.apache.wiki.workflow.AbstractStep
addError, addSuccessor, getAvailableOutcomes, getEndTime, getErrors, getMessageArguments, getMessageKey, getOutcome, getOwner, getStartTime, getSuccessor, getWorkflow, isCompleted, isStarted, setOutcome, setWorkflow, start
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-PageManager.PreSaveWikiPageTask

-
-public PageManager.PreSaveWikiPageTask(WikiContext context,
-                                       String proposedText)
-
-
Creates the task. -

-

-
Parameters:
context - The WikiContext
proposedText - The text that was just saved.
-
- - - - - - - - -
-Method Detail
- -

-execute

-
-public Outcome execute()
-                throws WikiException
-
-

- Executes the processing for this Step and returns an Outcome indicating - if it succeeded (Outcome.STEP_COMPLETE or - Outcome.STEP_ABORT). Processing instructions can do just about - anything, such as executing custom business logic or changing the Step's - final outcome via Step.setOutcome(Outcome). A return value of - STEP_COMPLETE indicates that the instructions executed completely, - without errors; STEP_ABORT indicates that the Step and its - parent Workflow should be aborted (that is, fail silently without error). - If the execution step encounters any errors, it should throw a - WikiException or a subclass. -

-

- Note that successful execution of this methods does not necessarily mean - that the Step is considered "complete"; rather, it just means that it has - executed. Therefore, it is possible that execute could run - multiple times. -

-

-

-
Specified by:
execute in interface Step
Specified by:
execute in class AbstractStep
-
-
- -
Returns:
the result of the Step, expressed as an Outcome -
Throws: -
WikiException - if the step encounters errors while executing
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
-Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. - - http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/8ce6b763/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.png b/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.png deleted file mode 100755 index b202e6a..0000000 Binary files a/content/apidocs/2.10.1/org/apache/wiki/PageManager.PreSaveWikiPageTask.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/8ce6b763/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.html ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.html b/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.html deleted file mode 100755 index a33101a..0000000 --- a/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - -PageManager.SaveWikiPageTask (Apache JSPWiki Main War 2.10.1 API) - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -org.apache.wiki -
-Class PageManager.SaveWikiPageTask

-
-java.lang.Object
-  extended by org.apache.wiki.workflow.AbstractStep
-      extended by org.apache.wiki.workflow.Task
-          extended by org.apache.wiki.PageManager.SaveWikiPageTask
-
-
-
All Implemented Interfaces:
Serializable, Step
-
-
-
Enclosing class:
PageManager
-
-
-
-
public static class PageManager.SaveWikiPageTask
extends Task
- - - - - -
- -

-Inner class that handles the actual page save and post-save actions. Instances - of this class are assumed to have been added to an approval workflow via - WorkflowBuilder.buildApprovalWorkflow(Principal, String, Task, String, org.apache.wiki.workflow.Fact[], Task, String); - they will not function correctly otherwise. -

- -

-

-
See Also:
Serialized Form
-
- -

- - - - - - - - - - - -
-Constructor Summary
PageManager.SaveWikiPageTask() - -
-          Creates the Task.
-  - - - - - - - - - - - -
-Method Summary
- Outcomeexecute() - -
-           - Executes the processing for this Step and returns an Outcome indicating - if it succeeded (Outcome.STEP_COMPLETE or - Outcome.STEP_ABORT).
-  - - - - - - - -
Methods inherited from class org.apache.wiki.workflow.Task
getActor, getSuccessor, setSuccessor
-  - - - - - - - -
Methods inherited from class org.apache.wiki.workflow.AbstractStep
addError, addSuccessor, getAvailableOutcomes, getEndTime, getErrors, getMessageArguments, getMessageKey, getOutcome, getOwner, getStartTime, getSuccessor, getWorkflow, isCompleted, isStarted, setOutcome, setWorkflow, start
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-PageManager.SaveWikiPageTask

-
-public PageManager.SaveWikiPageTask()
-
-
Creates the Task. -

-

- - - - - - - - -
-Method Detail
- -

-execute

-
-public Outcome execute()
-                throws WikiException
-
-

- Executes the processing for this Step and returns an Outcome indicating - if it succeeded (Outcome.STEP_COMPLETE or - Outcome.STEP_ABORT). Processing instructions can do just about - anything, such as executing custom business logic or changing the Step's - final outcome via Step.setOutcome(Outcome). A return value of - STEP_COMPLETE indicates that the instructions executed completely, - without errors; STEP_ABORT indicates that the Step and its - parent Workflow should be aborted (that is, fail silently without error). - If the execution step encounters any errors, it should throw a - WikiException or a subclass. -

-

- Note that successful execution of this methods does not necessarily mean - that the Step is considered "complete"; rather, it just means that it has - executed. Therefore, it is possible that execute could run - multiple times. -

-

-

-
Specified by:
execute in interface Step
Specified by:
execute in class AbstractStep
-
-
- -
Returns:
the result of the Step, expressed as an Outcome -
Throws: -
WikiException - if the step encounters errors while executing
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
-Copyright © {inceptionYear}-2014 The Apache Software Foundation. All rights reserved. - - http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/8ce6b763/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.png ---------------------------------------------------------------------- diff --git a/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.png b/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.png deleted file mode 100755 index 8747607..0000000 Binary files a/content/apidocs/2.10.1/org/apache/wiki/PageManager.SaveWikiPageTask.png and /dev/null differ