[JIRA-OS] Created: (WF-204) Javadoc enhancements to Workflow

Message:

  A new issue has been created in JIRA.

---------------------------------------------------------------------
View the issue:

  http://jira.opensymphony.com/secure/ViewIssue.jspa?key=WF-204


Here is an overview of the issue:
---------------------------------------------------------------------
        Key: WF-204
    Summary: Javadoc enhancements to Workflow
       Type: Improvement

     Status: Assigned
   Priority: Minor

    Project: OSWorkflow
 Components: 
             Core

   Assignee: Patrick Lightbody
   Reporter: Robert Dawson

    Created: Wed, 3 Sep 2003 5:42 AM
    Updated: Wed, 3 Sep 2003 5:42 AM

Description:
The JavaDoc on the initialise method is poor.

It calls the workflowName the workflow instance -- which doesn't match the normal usage of what a workflow instance.

I have reworded this, and added in the return statement.  It could probably use some futher rewording, but this is a good start methinks.

   /**
    * Initializes a workflow so that it can begin processing. A workflow must be initialized before it can
    * begin any sort of activity. It can only be initialized once.
    *
    * @param workflowName the name of the workflow definition to initialize an instance of a flow for.
    * @param initialAction the initial step to start the workflow.
    * @param inputs The inputs entered by the end-user.
    * @return Return the long ID of the workflow instance.
    * @throws InvalidRoleException if the user can't start this function.
    * @throws InvalidInputException if a validator is specified and an input is invalid.
    */
    public long initialize(String workflowName, int initialAction, Map inputs) throws InvalidRoleException, InvalidInputException, WorkflowException;



---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.

If you think it was sent incorrectly contact one of the administrators:
   http://jira.opensymphony.com/secure/Administrators.jspa

If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf