svn commit: r1126706 - in /ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow: ./ client/ impl/

[mrisaliti]

Author: mrisaliti
Date: Mon May 23 20:06:40 2011
New Revision: 1126706

URL: http://svn.apache.org/viewvc?rev=1126706&view=rev
Log:
Removed some javadoc warning (wrong param/return) into workflow component no functional changes

Modified:
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfActivity.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignment.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignmentEventAudit.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfCreateProcessEventAudit.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfDataEventAudit.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfEventAudit.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfExecutionObject.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcess.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcessMgr.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfResource.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfStateEventAudit.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/client/WorkflowClient.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfExecutionObjectImpl.java
    ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfResourceImpl.java

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfActivity.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfActivity.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfActivity.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfActivity.java Mon May 23 20:06:40 2011
@@ -74,7 +74,7 @@ public interface WfActivity extends WfEx
 
     /**
      * Assign Result for this activity.
-     * @param newResult New result.
+     * @param result New result.
      * @throws WfException General workflow exception.
      * @throws InvalidData Data is invalid
      */

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignment.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignment.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignment.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignment.java Mon May 23 20:06:40 2011
@@ -62,7 +62,7 @@ public interface WfAssignment {
 
     /**
      * Set the results of this assignment.
-     * @param Map The results of the assignement.
+     * @param results Map The results of the assignement.
      * @throws WfException
      */
     public void setResult(Map<String, Object> results) throws WfException;

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignmentEventAudit.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignmentEventAudit.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignmentEventAudit.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfAssignmentEventAudit.java Mon May 23 20:06:40 2011
@@ -25,25 +25,25 @@ public interface WfAssignmentEventAudit
 
     /**
      * @throws WfException
-     * @return
+     * @return return old resource key
      */
     public String oldResourceKey() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return old resource name
      */
     public String oldResourceName() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return new resource key
      */
     public String newResourceKey() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return new resource name
      */
     public String newResourceName() throws WfException;
 

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfCreateProcessEventAudit.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfCreateProcessEventAudit.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfCreateProcessEventAudit.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfCreateProcessEventAudit.java Mon May 23 20:06:40 2011
@@ -25,31 +25,31 @@ public interface WfCreateProcessEventAud
 
     /**
      * @throws WfException
-     * @return
+     * @return return the activity key
      */
     public String pActivityKey() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process key
      */
     public String pProcessKey() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process name
      */
     public String pProcessName() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process mgr name
      */
     public String pProcessMgrName() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process mgr version
      */
     public String pProcessMgrVersion() throws WfException;
 

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfDataEventAudit.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfDataEventAudit.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfDataEventAudit.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfDataEventAudit.java Mon May 23 20:06:40 2011
@@ -27,13 +27,13 @@ public interface WfDataEventAudit {
 
     /**
      * @throws WfException
-     * @return
+     * @return return the old data
      */
     public Map<String, Object> oldData() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the new data
      */
     public Map<String, Object> newData() throws WfException;
 

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfEventAudit.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfEventAudit.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfEventAudit.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfEventAudit.java Mon May 23 20:06:40 2011
@@ -28,55 +28,55 @@ public interface WfEventAudit {
     /**
      * @throws WfException
      * @throws SourceNotAvailable
-     * @return
+     * @return return the source
      */
     public WfExecutionObject source() throws WfException, SourceNotAvailable;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the timestamp
      */
     public Timestamp timeStamp() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the event type
      */
     public String eventType() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the activity key
      */
     public String activityKey() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the activity name
      */
     public String activityName() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process key
      */
     public String processKey() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process name
      */
     public String processName() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process mgr name
      */
     public String processMgrName() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return return the process mgr version
      */
     public String processMgrVersion() throws WfException;
 

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfExecutionObject.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfExecutionObject.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfExecutionObject.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfExecutionObject.java Mon May 23 20:06:40 2011
@@ -39,7 +39,7 @@ public interface WfExecutionObject {
 
     /**
      * @throws WfException General workflow exception.
-     * @return
+     * @return return a list
      */
     public List<String> whileOpenType() throws WfException;
 
@@ -243,14 +243,14 @@ public interface WfExecutionObject {
 
     /**
      * Gets the GenericValue object of the definition.
-     * @returns GenericValue object of the definition.
+     * @return returns GenericValue object of the definition.
      * @throws WfException
      */
     public GenericValue getDefinitionObject() throws WfException;
 
     /**
      * Gets the GenericValue object of the runtime workeffort.
-     * @returns GenericValue object of the runtime workeffort.
+     * @return returns GenericValue object of the runtime workeffort.
      * @throws WfException
      */
     public GenericValue getRuntimeObject() throws WfException;

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcess.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcess.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcess.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcess.java Mon May 23 20:06:40 2011
@@ -44,13 +44,13 @@ public interface WfProcess extends WfExe
 
     /**
      * @throws WfException
-     * @return
+     * @return returns how many steps
      */
     public int howManyStep() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns an iterator of WfActivity
      */
     public Iterator<WfActivity> getIteratorStep() throws WfException;
 
@@ -64,14 +64,14 @@ public interface WfProcess extends WfExe
     /**
      * @param member
      * @throws WfException
-     * @return
+     * @return returns if is a member of step
      */
     public boolean isMemberOfStep(WfActivity member) throws WfException;
 
     /**
      * Gets the manager associated with this process
      * @throws WfException
-     * @return
+     * @return returns the manager
      */
     public WfProcessMgr manager() throws WfException;
 
@@ -119,7 +119,8 @@ public interface WfProcess extends WfExe
      * @param state
      * @throws WfException
      * @throws InvalidState
-     * @return
+     * @return returns an iterator of WfActivity
+    
      */
     public Iterator<WfActivity> getActivitiesInState(String state) throws WfException, InvalidState;
 

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcessMgr.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcessMgr.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcessMgr.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfProcessMgr.java Mon May 23 20:06:40 2011
@@ -29,13 +29,13 @@ public interface WfProcessMgr {
 
     /**
      * @throws WfException
-     * @return
+     * @return returns how many process
      */
     public int howManyProcess() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns an iterator of WfProcess
      */
     public Iterator<WfProcess> getIteratorProcess() throws WfException;
 
@@ -49,13 +49,13 @@ public interface WfProcessMgr {
     /**
      * @param member
      * @throws WfException
-     * @return
+     * @return returns if is a member of process
      */
     public boolean isMemberOfProcess(WfProcess member) throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the process manager state type
      */
     public List<String> processMgrStateType() throws WfException;
 
@@ -68,37 +68,37 @@ public interface WfProcessMgr {
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the name
      */
     public String name() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the description
      */
     public String description() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the category
      */
     public String category() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the version
      */
     public String version() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the context signature
      */
     public Map<String, Object> contextSignature() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the result signature
      */
     public Map<String, Object> resultSignature() throws WfException;
 

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfResource.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfResource.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfResource.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfResource.java Mon May 23 20:06:40 2011
@@ -86,8 +86,8 @@ public interface WfResource {
 
     /**
      * Release the resouce from the assignement
-     * @param fromAssigment
-     * @param releaseInfo
+     * @param fromAssignment the from assignement
+     * @param releaseInfo the release information
      * @throws WfException
      * @throws NotAssigned
      */

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfStateEventAudit.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfStateEventAudit.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfStateEventAudit.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/WfStateEventAudit.java Mon May 23 20:06:40 2011
@@ -25,13 +25,13 @@ public interface WfStateEventAudit exten
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the old state
      */
     public String oldState() throws WfException;
 
     /**
      * @throws WfException
-     * @return
+     * @return returns the new state
      */
     public String newState() throws WfException;
 

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/client/WorkflowClient.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/client/WorkflowClient.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/client/WorkflowClient.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/client/WorkflowClient.java Mon May 23 20:06:40 2011
@@ -67,7 +67,7 @@ public class WorkflowClient {
 
     /**
      * Get a new instance of the Workflow Client
-     * @param dctx A DispatchContext object.
+     * @param context A DispatchContext object.
      * *** Note the delegator from this object must match the delegator used by the workflow engine.
      */
     public WorkflowClient(DispatchContext context) {
@@ -116,7 +116,6 @@ public class WorkflowClient {
      * @param partyId The assigned / to be assigned users party ID.
      * @param roleTypeId The assigned / to be assigned role type ID.
      * @param fromDate The assignment's from date.
-     * @return GenericResultWaiter of the start job.
      * @throws WfException
      */
     public void acceptAndStart(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate) throws WfException {
@@ -187,12 +186,14 @@ public class WorkflowClient {
 
     /**
      * Delegate and accept an activity assignment.
-     * @param workEffortId The WorkEffort entity ID for the activitiy.
-     * @param partyId The assigned / to be assigned users party ID.
-     * @param roleTypeId The assigned / to be assigned role type ID.
-     * @param fromDate The assignment's from date.
+     * @param workEffortId the WorkEffort entity ID for the activitiy.
+     * @param fromPartyId the from users party ID.
+     * @param fromRoleTypeId the from role type ID.
+     * @param fromFromDate the from date.
+     * @param toPartyId the assigned users party ID.
+     * @param toRoleTypeId the assigned role type ID.
+     * @param toFromDate the assignment's to date.
      * @param start True to attempt to start the activity.
-     * @return GenericResultWaiter of the start job.
      * @throws WfException
      */
     public void delegateAndAccept(String workEffortId, String fromPartyId, String fromRoleTypeId, Timestamp fromFromDate, String toPartyId, String toRoleTypeId, Timestamp toFromDate, boolean start) throws WfException {
@@ -215,7 +216,6 @@ public class WorkflowClient {
     /**
      * Start the activity.
      * @param workEffortId The WorkEffort entity ID for the activitiy.
-     * @return GenericResultWaiter of the start job.
      * @throws WfException
      */
     public void start(String workEffortId) throws WfException {
@@ -246,7 +246,7 @@ public class WorkflowClient {
      * @param partyId The assigned / to be assigned users party ID.
      * @param roleTypeId The assigned / to be assigned role type ID.
      * @param fromDate The assignment's from date.
-     * @return GenericResultWaiter for the complete job.
+     * @param result The assignment result.
      * @throws WfException
      */
     public void complete(String workEffortId, String partyId, String roleTypeId, Timestamp fromDate, Map<String, Object> result) throws WfException {
@@ -344,7 +344,6 @@ public class WorkflowClient {
      * Set the state of the execution object defined by the work effort key.
      * @param workEffortId The WorkEffort entity key for the execution object.
      * @param state The new state of the execution object.
-     * @return Current state of the execution object as a string.
      * @throws WfException If state change is not allowed.
      */
     public void setState(String workEffortId, String state) throws WfException {

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfExecutionObjectImpl.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfExecutionObjectImpl.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfExecutionObjectImpl.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfExecutionObjectImpl.java Mon May 23 20:06:40 2011
@@ -551,7 +551,6 @@ public abstract class WfExecutionObjectI
 
     /**
      * Updates the runtime data entity
-     * @param field The field name of the entity (resultDataId,contextDataId)
      * @param value The value to serialize and set
      * @throws WfException
      */

Modified: ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfResourceImpl.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfResourceImpl.java?rev=1126706&r1=1126705&r2=1126706&view=diff
==============================================================================
--- ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfResourceImpl.java (original)
+++ ofbiz/trunk/specialpurpose/workflow/src/org/ofbiz/workflow/impl/WfResourceImpl.java Mon May 23 20:06:40 2011
@@ -49,11 +49,11 @@ public class WfResourceImpl implements W
 
     /**
      * Creates a new WfResource
+     * @param delegator the delegator
      * @param resourceKey Uniquely identifies the resource
      * @param resourceName The name of the resource
      * @param partyId The partyID of this resource
      * @param roleTypeId The roleTypeId of this resource
-     * @param fromDate The fromDate of this resource
      */
     public WfResourceImpl(Delegator delegator, String resourceKey, String resourceName, String partyId, String roleTypeId) {
         this.delegator = delegator;