netbpm.xml

工作流

        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.GetTaskList(System.Collections.IList)">
            <summary> collects all{@link NetBpm.Workflow.Execution.IFlow}s for which the given 
            collection of actors has to performed an activity.
            </summary>
            <param name="actorIds">the collection of actor Ids
            </param>
            <returns> a Collection of {@link NetBpm.Workflow.Execution.IFlow}s which are 
            assigned to the <a href="#authentication">{@link Nbpm.Workflow.Organisation.IActor}
            ({@link Nbpm.Workflow.Organisation.IUser} or {@link Nbpm.Workflow.Organisation.IGroup} 
            calling this method</a>.
            </returns>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.GetTaskList(System.Collections.IList,NetBpm.Util.Client.Relations)">
            <summary> collects all {@link NetBpm.Workflow.Execution.IFlow}s for which the given 
            collection of actors has to perform an activity.
            </summary>
            <param name="actorIds">the collection of actor Ids
            </param>
            <param name="relations">specifies which {@link Relations} should be resolved in the
            returned {@link NetBpm.Workflow.Execution.IFlow}s
            </param>
            <returns> a Collection of {@link NetBpm.Workflow.Execution.IFlow}s which are 
            assigned to the <a href="#authentication">{@link Nbpm.Workflow.Organisation.IActor}
            ({@link Nbpm.Workflow.Organisation.IUser} or {@link Nbpm.Workflow.Organisation.IGroup} 
            calling this method</a>.
            </returns>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.StartProcessInstance(System.Int64)">
            <summary> provides default values (=null) for the optional parameters of 
            {@link #startProcessInstance(Long,Map,String,Relations)}
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.StartProcessInstance(System.Int64,System.Collections.IDictionary)">
            <summary> provides default values (=null) for the optional parameters of 
            {@link #startProcessInstance(Long,Map,String,Relations)}
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.StartProcessInstance(System.Int64,System.Collections.IDictionary,System.String)">
            <summary> provides default values (=null) for the optional parameters of 
            {@link #startProcessInstance(Long,Map,String,Relations)}
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.StartProcessInstance(System.Int64,System.Collections.IDictionary,System.String,NetBpm.Util.Client.Relations)">
            <summary> creates a new process instance for the given process definition.
            Starting a process instance means that the start-activity is performed.
            </summary>
            <param name="processDefinitionId">the id of a ProcessDefinition
            </param>
            <param name="attributeValues">maps attribute-names to java-objects.  The java-objects will be stored
            in the corresponding attribute-instances.
            </param>
            <param name="transitionName">specifies which transition should be taken from the start-state in case
            there are more then one.
            </param>
            <param name="relations">specifies which {@link Relations} should be resolved in the 
            returned {@link Nbpm.Workflow.Execution.IProcessInstance}s
            </param>
            <returns> the created {@link Nbpm.Workflow.Execution.IProcessInstance}
            @throws IllegalArgumentException if processDefinitionId is null or does not correspond with an existing process definition
            </returns>
            <seealso cref="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.GetProcessDefinitions">
            use GetProcessDefinitions() to get valid processDefinitionId's
            </seealso>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.GetStartForm(System.Int64)">
            <summary> fetches all web-interface information for the start of a process instance.  
            @throws AttributeSerializationException if the attributes that are stored in the database as 
            text can't be parsed to a java-object with the {@link Nbpm.Workflow.Delegation.ISerializer}
            @throws ExecutionRuntimeException for all other troubles
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.GetActivityForm(System.Int64)">
            <summary> fetches all web-interface information for the activity of a flow.  
            @throws AttributeSerializationException if the attributes that are stored in the database as 
            text can't be parsed to a java-object with the {@link Nbpm.Workflow.Delegation.ISerializer}
            @throws ExecutionRuntimeException for all other troubles
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.PerformActivity(System.Int64)">
            <summary> provides default values (=null) for the optional parameters of 
            {@link #startProcessInstance(Long,Map,String,Relations)}
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.PerformActivity(System.Int64,System.Collections.IDictionary)">
            <summary> provides default values (=null) for the optional parameters of 
            {@link #startProcessInstance(Long,Map,String,Relations)}
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.PerformActivity(System.Int64,System.Collections.IDictionary,System.String)">
            <summary> provides default values (=null) for the optional parameters of 
            {@link #startProcessInstance(Long,Map,String,Relations)}
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.PerformActivity(System.Int64,System.Collections.IDictionary,System.String,NetBpm.Util.Client.Relations)">
            <summary> performs an {@link ActivityState}.</summary>
            <returns> a collection of {@link Flow}'s that are the {@link Flow}s, resulting 
            from the {@link Flow} on which the {@link Activity} was done, after processing 
            the {@link Activity} input.
            </returns>
            <param name="flowId">is the id of the flow upon which the client wants to act.
            Flows can be obtained by {@link #getTaskList()}
            </param>
            <param name="attributeValues">maps attribute-names to java-objects.  The java-objects will be stored
            in the corresponding attribute-instances.
            </param>
            <param name="transitionName">specifies which transition should be taken from the start-state in case
            there are more then one.
            </param>
            <param name="relations">specifies which {@link Relations} should be resolved in the 
            returned {@link NetBpm.Workflow.Execution.IFlow}s
            @throws RequiredFieldException if not all required fields are
            present in the form-values.
            @throws AttributeSerializationException if one of the fieldValues
            is not serializable by the {@link Nbpm.Workflow.Delegation.ISerializer} 
            specified in the corresponding field.
            @throws IllegalArgumentException if the {@link Flow} of the form cannot be found.
            @throws IllegalStateException if the {@link Flow} is not in an activity-state.
            </param>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.DelegateActivity(System.Int64,System.String)">
            <summary> reassigns the {@link Flow} to the specified {@link Actor}.</summary>
            <param name="flowId">is the flow which the authenticated user wants to delegate
            </param>
            <param name="actorId">is the user or group of the user to which the the flow is assigned.
            @throws IllegalArgumentException if the flow or the user do not exist.
            </param>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.CancelProcessInstance(System.Int64)">
            <summary> cancels a complete process instance including all flows that are part of this process instance.
            @throws IllegalArgumentException if the flow does not exist.
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.CancelFlow(System.Int64)">
            <summary> cancels one flow without cancelling the complete process instance.
            @throws IllegalArgumentException if the flow does not exist.
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.GetFlow(System.Int64)">
            <summary> collects a flow.
            @throws IllegalArgumentException if the flow does not exist.
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.EComp.IExecutionSessionLocal.GetFlow(System.Int64,NetBpm.Util.Client.Relations)">
            <summary> collects a flow.</summary>
            <param name="relations">specifies which {@link Relations} should be resolved in the 
            returned {@link NetBpm.Workflow.Execution.IFlow}
            @throws IllegalArgumentException if the flow does not exist.
            </param>
        </member>
        <member name="T:NetBpm.Workflow.Execution.IActivityForm">
             <summary> contains all data necessary for the web-application to create a
             html-form that enables a human-user to perform an {@link ActivityState}. 
             </summary>
            @portme ISerializable
        </member>
        <member name="P:NetBpm.Workflow.Execution.IActivityForm.Flow">
            <summary> gets the Flow which is waiting in the {@link ActivityState} to be performed.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IActivityForm.ProcessDefinition">
            <summary> gets the {@link ProcessDefinition} of this {@link ActivityState}.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IActivityForm.Activity">
            <summary> gets the {@link ActivityState} for which all this fuzz is about.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IActivityForm.Fields">
            <summary> contains the information to build up the form.</summary>
            <returns> a List of {@link Fields} that is ordered in the same
            way as in the web-interface.xml file.  
            </returns>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IActivityForm.AttributeValues">
            <summary> for attributes that are readable in this activity, 
            the returned object will map attribute-names to attribute-values.
            </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IActivityForm.TransitionNames">
            <summary> gets the list of all named transitions leaving the {@link ActivityState}.</summary>
        </member>
        <member name="T:NetBpm.Workflow.Execution.IAttributeInstance">
            <summary> is a process-variable associated with one process instance.
            The value can be changed during the execution of the flow in following ways :
            <ul>
            <li><b>field input</b> : In the {@link ProcessDefinition}, 
            a {@link Field} associates an attribute with an {@link Activity}.  
            When an actor performs that {@link Activity}, it has to provide input 
            for the attribute. The value that is provided by the actor is stored in the 
            AttributeInstance.</li>
            <li><b>role association</b> : A special kind of AttributeInstances is the 
            role-attribute-instance.  They are specified by the actorName-property in 
            the activity. If an actor performs an activity, the attribute-instance with name 
            actorName is set to the actor.</li>
            </ul>
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.IAttributeInstance.GetValue">
            <summary> is the java-object-value for this AttributeInstance.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IAttributeInstance.Id">
            <summary> the meaningless primary-key for this object. </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IAttributeInstance.ValueText">
            <summary> gets the text as it is store in the database in serialized form.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IAttributeInstance.Attribute">
            <summary> is the {@link Attribute} of this AttributeInstance.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IAttributeInstance.Scope">
            <summary> is the {@link Flow} to which this AttributeInstance is associated.</summary>
        </member>