[jbossseam-issues] [JBoss JIRA] Created: (JBSEAM-1048) Documentation enhancement for injecting TaskInstance and ProcessInstance (add full package name)

[Arjan van Bentem (JIRA)]

Documentation enhancement for injecting TaskInstance and ProcessInstance (add full package name)
------------------------------------------------------------------------------------------------

                 Key: JBSEAM-1048
                 URL: http://jira.jboss.com/jira/browse/JBSEAM-1048
             Project: JBoss Seam
          Issue Type: Feature Request
          Components: Documentation
    Affects Versions: 1.2.0.GA
         Environment: All
            Reporter: Arjan van Bentem
            Priority: Optional


This may be too obvious for some, but maybe, just maybe, the following needs some enhancements:

http://fisheye.jboss.com/browse/JBoss/jboss-seam/doc/reference/en/modules/annotations.xml?r=1.55 reads:

        @StartTask
        [...]
        The jBPM TaskInstance will be available in a request context variable
        named taskInstance. The jPBM ProcessInstance will be available in a
        request context variable named processInstance. (Of course, these
        objects are available for injection via @In.)

Built-in Seam components TaskInstance and ProcessInstance exist, but in fact are not used here. Due to the @Unwrap in org.jboss.seam.core.TaskInstance and ProcessInstance one actually gets an org.jbpm.taskmgmt.exe.TaskInstance and an org.jbpm.graph.exe.ProcessInstance injected.

The exception when the Java code expects a Seam component is in fact clear:

        java.lang.IllegalArgumentException: Could not set field value by reflection:
        TodoList.processInstance on: org.jboss.seam.example.todo.TodoList with
        value: class org.jbpm.graph.exe.ProcessInstance

However, this error might be embedded in a long list of other exceptions. For example, when adding the injection to the TodoList example it will be the 5th embedded exception in a message that starts with "javax.servlet.ServletException: Cannot get value for expression '#{todoList.description}'".

Fix:

Maybe the text above could be changed to include the full package name (hoping that it will not change in the near future):

        The jBPM org.jbpm.taskmgmt.exe.TaskInstance will be available in a request context variable
        named taskInstance. The jBPM org.jbpm.graph.exe.ProcessInstance will be available in a
        request context variable named processInstance. (Of course, these
        objects are available for injection via @In.)

The very same text applies to @BeginTask.

When not changing the documentation then, as of now, at least JIRA will show a hit when searching for "injection AND ProcessInstance" ;-)


-- 
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