[jbossseam-issues] [JBoss JIRA] Created: (JBSEAM-1094) Javadoc enhancement for @CreateProcess (add note about handling of null result)

[Arjan van Bentem (JIRA)]

Javadoc enhancement for @CreateProcess (add note about handling of null result)
-------------------------------------------------------------------------------

                 Key: JBSEAM-1094
                 URL: http://jira.jboss.com/jira/browse/JBSEAM-1094
             Project: JBoss Seam
          Issue Type: Bug
          Components: BPM
    Affects Versions: 1.2.0.GA
         Environment: IDE inline help
            Reporter: Arjan van Bentem
            Priority: Trivial


The Javadoc for org.jboss.seam.annotations.CreateProcess states at http://fisheye.jboss.com/browse/JBoss/jboss-seam/src/main/org/jboss/seam/annotations/CreateProcess.java?r=1.3#l16

    Marks a method creating a jBPM {@link org.jbpm.graph.exe.ProcessInstance process}
    so long as the method does not throw an exception.

However, returning null for a non-void method also does not signal jBPM to start the process. So, for the sake of inline help in the IDE's I guess this should read:

    Marks a method creating a jBPM {@link org.jbpm.graph.exe.ProcessInstance process}
    when the method returns a non-null outcome without exception. When intentionally 
    never returning a value then the method should be declared void.

By the way: the documentation is correct, and states at http://fisheye.jboss.com/browse/JBoss/jboss-seam/doc/reference/en/modules/annotations.xml?r=1.57#l680

    Creates a new jBPM process instance when the method returns a 
    non-null outcome without exception. The ProcessInstance object will
    be available in a context variable named processInstance.

Thanks!
Arjan.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira