netbpm.xml

工作流

        <member name="P:NetBpm.Workflow.Execution.Impl.ExecutionComponentImpl.Instance">
            <summary> gets the singleton instance.</summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.Impl.ExecutionContextImpl.#ctor">
            <summary> the default constructor is necessary for the ActorExpressionTest.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.Impl.ExecutionEngineImpl.Instance">
            <summary> gets the singleton instance.</summary>
        </member>
        <member name="T:NetBpm.Workflow.Execution.IFlow">
            <summary> represents one 'thread-of-execution' for a sequence of {@link Activity}s.
            
            <p>Flows hierarchically ordered.  When starting a process instance, a root-flow will be
            created. At a fork, the parent-flow will spawn a set of child-flows and then wait until 
            they join again.
            </p>
            
            <p>getNode() represents the state of a flow. 
            A flow is always in one of 4 states : 
            <ol>
            <li>activity : the flow is waiting until an actor performs the activity. All 
            state-getters will return null except getNode(), 
            which will return an {@link ActivityState}</li> 
            <li>fork : a flow is assigned to a fork when it is waiting on its
            subflows to join again. All state-getters will return null except getNode(), 
            which will return a {@link Fork}</li> 
            <li>join : a flow is assigned to a join when it is waiting on its brothers- and 
            sister-flows to join before the parent-flow is reactivated All state-getters will 
            return null except getNode(), which will return a {@link Join}</li> 
            <li>ended : meaning is obvious.
            All state-getters will return null.</li> 
            </ol>
            </p> 
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.IFlow.GetSubProcessInstance">
            <summary> is the sub-process-instance on which this flow is waiting
            in a sub-process-activity.
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.IFlow.IsRootFlow">
            <summary> tells if this flow is the root-flow of a processInstance.</summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.IFlow.GetActor">
            <summary> specifies which User or Group is supposed to act upon the Flow.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.Id">
            <summary> the meaningless primary-key for this object. </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.Name">
            <summary> is the name of the flow.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.Node">
            <summary> is a pointer to the {@link Node} in the activity diagram that represents the state of this flow.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.Logs">
            <summary> are the logged events related to this flow.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.Start">
            <summary> is the time at which this flow started.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.End">
            <summary> is the time at which this flow ended, null if it didn't end yet.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.AttributeInstances">
            <summary> are the flow-local attributes.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.Parent">
            <summary> is the parent-Flow of this flow.  Flows are hierarchically ordered
            as described in the general-class-description part above.
            </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.ProcessInstance">
            <summary> is the {@link ProcessInstance} of this flow.  The {@link ProcessInstance} is
            associated with the upper-most parent of this flow.  Flows are hierarchically 
            ordered as described in the general-class-description part above.
            </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IFlow.Children">
            <summary> is the collection of child-Flows for this Flow. Flows are hierarchically ordered
            as described in the general-class-description part above.
            </summary>
            <returns> a Collection of Flow's 
            </returns>
        </member>
        <member name="P:NetBpm.Workflow.Execution.Impl.FlowImpl.SubProcessInstances">
            <summary> Hibernate only supports 1-1 relations if the objects have the same id.  Since that was not 
            easily achievable, I decided to make it an 1-n relation towards hibernate, but masked the 
            collections property private.  Then I added the property getter and setter which put or get 
            the single object from the collection.  
            </summary>
            <seealso cref="M:NetBpm.Workflow.Execution.Impl.FlowImpl.GetSubProcessInstance">
            </seealso>
            <seealso cref="M:NetBpm.Workflow.Execution.Impl.FlowImpl.SetSubProcessInstance(NetBpm.Workflow.Execution.IProcessInstance)">
            </seealso>
        </member>
        <member name="T:NetBpm.Workflow.Execution.IProcessInstance">
            <summary> is one execution of a {@link ProcessDefinition}.</summary>
        </member>
        <member name="M:NetBpm.Workflow.Execution.IProcessInstance.GetInitiator">
            <summary> is the actor that started this process instance. </summary>
            <returns> Actor
            </returns>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IProcessInstance.Id">
            <summary> the meaningless primary-key for this object. </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IProcessInstance.Start">
            <summary> the date this instance started. </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IProcessInstance.End">
            <summary> the date this instance ended or null if this instance has
            not yet ended.
            </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IProcessInstance.ProcessDefinition">
            <summary> the {@link ProcessDefinition} of this instance.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IProcessInstance.RootFlow">
            <summary> the top-level flow of this instance.  Note that 
            forks and joins create a hierarchically ordered
            tree of flows.
            </summary>
        </member>
        <member name="P:NetBpm.Workflow.Execution.IProcessInstance.SuperProcessFlow">
            <summary> if this instance is executed as an activity
            of a higher-level process, this is the {@link Flow}
            which is waiting in a activity for this instance to complete.
            </summary>
            <seealso cref="T:NetBpm.Workflow.Delegation.IProcessInvocationHandler">
            </seealso>
        </member>
        <member name="T:NetBpm.Workflow.Execution.AuthorizationException">
            <summary> is a RuntimeException that is thrown when an actor
            tries to perform an operation that is not permitted
            by the ExecutionAuthorizationMgr. 
            </summary>
        </member>
        <member name="T:NetBpm.Workflow.Execution.ExecutionException">
            <summary> is a RuntimeException that serves as a base-class for exceptions that are 
            related to process execution.
            </summary>
        </member>
        <member name="T:NetBpm.Workflow.Execution.ExecutionComponent">
            @todo remove this interface is not in use!!!!!
            <summary> is the session facade that exposes the interface for the execution of processes.
            <h3>WfMC</h3>
            <p>In <a href="http://www.wfmc.org/standards/docs.htm">WfMC-terminology</a> this is interface 2 : Workflow Client API.
            </p>
            
            <h3 id="authentication">Authentication</h3>
            <p>Authentication is letting the ExecutionSession-bean know which user is calling a method.
            There are 2 ways of authenticating the User that executes a method upon an ExecutionSession-bean.
            <ol>
            <li>using J2EE-security and the stateless session bean. See {@link ExecutionSecuredSessionLocalHome}</li>
            <li>using the statefull non-secure session bean. See {@link ExecutionSessionLocalHome}.  In this
            case, the client can freely specify the user-name.</li>
            </ol>
            </p>
            
            <h3>Component interface</h3>
            <p>The two most important interactions with the ExecutionSession-bean are
            <ol>
            <li><b>Start a process instance</b> : first you need to know the id of the process definition
            you want to start.  This can be done by e.g. {@link #getProcessDefinitions()}.  Then start a process 
            instance with {@link #startProcessInstance(Long processDefinitionId)}.
            </li>
            <li><b>Perform an activity for a flow</b> : first a user can get the list of
            flows for which he/she is supposed to act through {@link #getTaskList()}.
            Then the user can perform the activity with {@link #performActivity(Long,Map)}
            </li>
            </ol>
            </p>
            
            </summary>
            <seealso cref="T:NetBpm.Workflow.Organisation.EComp.IOrganisationSessionLocal">
            </seealso>
            <seealso cref="T:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal">
            </seealso>
        </member>
        <member name="M:NetBpm.Workflow.Execution.ExecutionComponent.getTaskList">
            <summary> collects all {@link NetBpm.Workflow.Execution.IFlow}s for which the authenticated 
            user has to perform an activity.
            </summary>
            <returns> a Collection of {@link NetBpm.Workflow.Execution.IFlow}s which are 
            assigned to the <a href="#authentication">user calling this method</a>.
            </returns>
        </member>
        <member name="M:NetBpm.Workflow.Execution.ExecutionComponent.getTaskList(NetBpm.Util.Client.Relations)">
            <summary> collects all {@link NetBpm.Workflow.Execution.IFlow}s for which the authenticated 
            user has to perform an activity.
            </summary>
            <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">authenticated user</a>.
            </returns>
        </member>
        <member name="M:NetBpm.Workflow.Execution.ExecutionComponent.getTaskList(System.String)">
            <summary> collects all {@link NetBpm.Workflow.Execution.IFlow}s for which the given
            actor has to perform an activity.  Note that an actor can be a group.
            </summary>
            <param name="actorId">the actor id
            </param>
            <returns> a Collection of {@link NetBpm.Workflow.Execution.IFlow}s which are