netbpm.xml

工作流

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>NetBpm</name>
    </assembly>
    <members>
        <member name="T:NetBpm.Util.Client.Relations">
            <summary> specifies which related objects should be resolved for data-transfer-objects,
            returned from a session-facade.
            
            <p>A session facade is supposed to collect data from the persistency-layer
            and return data-transfer-objects to the client.  If the datamodel has a lot
            of relations, a problem arises : Which related objects should be resolved in
            the object that is returned to the client.  A Relations-object is a convenient way of specifying
            which related objects you want to be resolve on the objects returned by the session facade.
            You can specify these Relations with dot-separated property-names.
            E.g. if the returned object is a Flow, "attributeInstance.attribute" specifies that
            for every returned Flow-object the methods Collection getAttributeInstance() must
            be resolved and that these AttributeInstances have the Attribute getAttribute()
            resolved. 
            </p>
            
            </summary>
        </member>
        <member name="M:NetBpm.Util.Client.Relations.#ctor(System.String)">
            <summary> creates a Relation from one dot-separated property descriptor.</summary>
            <param name="property">is a dot-separated property descriptor.
            </param>
        </member>
        <member name="M:NetBpm.Util.Client.Relations.#ctor(System.String[])">
            <summary> creates a Relation from multiple dot-separated property descriptor.</summary>
            <param name="properties">is a dot-separated property descriptor.
            </param>
        </member>
        <member name="M:NetBpm.Util.Client.ServiceLocator.GetService(System.Type)">
            <summary> Get a netbpm component. Following are valid interfaceClass. If invalid 
            interfaceClass are supplied, an error will be logged.
            </summary>
            <param name="interfaceClass">interfaceClass
            </param>
            <returns> Object
            </returns>
        </member>
        <member name="P:NetBpm.Util.Client.ServiceLocator.Instance">
            <summary> get an instance of this service locator with default params</summary>
            <returns>ServiceLocator</returns>
        </member>
        <member name="T:NetBpm.Util.DB.DbSession">
            <summary> This class wraps the Hibernate Session.
            It adds the guarantee that if a method throws an exception, the session will already be closed.
            Furthermore, this wrapper adds 2 convenience-methods findOne(...) and iterateOne(...) that checks if exactly one object is returned and extracts that single object from the collection. 
            </summary>
        </member>
        <member name="T:NetBpm.Util.DB.DbType">
            <summary> This class wraps all the hibernate types so that 
            users of this package don't have to include the net.sf.hibernate packages.
            </summary>
        </member>
        <member name="T:NetBpm.Util.EComp.AbstractEComp">
            <summary>
            </summary>
        </member>
        <member name="T:NetBpm.Util.NAnt.DeployPar">
            <summary>
            This task deploys par archives.
            </summary>
        </member>
        <member name="T:NetBpm.Util.Net.ArrayUtil">
            <summary> is a utility class for common Array-methods that are not available in the system libraries. </summary>
        </member>
        <member name="M:NetBpm.Util.Net.ArrayUtil.ToString(System.Object[])">
            <summary> writes an Array to a String.</summary>
        </member>
        <member name="T:NetBpm.Util.Xml.XmlParser">
            <summary> convenience class for parsing and/or validating xml documents.
            </summary>
        </member>
        <member name="M:NetBpm.Util.Xml.XmlParser.#ctor(System.IO.Stream)">
            <summary> creates an XmlParser for an inputStream (conaining an xml-document).
            @throws NullPointerException if inputStream is null. 
            @portme
            </summary>
        </member>
        <member name="M:NetBpm.Util.Xml.XmlParser.#ctor(System.Xml.XmlReader)">
            <summary> creates an XmlParser for an inputStream (conaining an xml-document).
            @throws NullPointerException if inputStream is null. 
            @portme
            </summary>
        </member>
        <member name="M:NetBpm.Util.Xml.XmlParser.#ctor(System.String)">
            <summary> creates an XmlParser for an inputStream (conaining an xml-document).
            @throws NullPointerException if reader is null. 
            </summary>
        </member>
        <member name="M:NetBpm.Util.Xml.XmlParser.Validate">
            <summary> validates an xml-document without building a XmlElement's for the parsed contents.</summary>
        </member>
        <member name="M:NetBpm.Util.Xml.XmlParser.Parse">
            <summary> parses and/or validates an xml document.
            @throws IllegalStateException if this parser has already been used before.  It can only be
            used once because the inputSource can be read only once.
            </summary>
        </member>
        <member name="T:NetBpm.Workflow.Definition.Attr.Evaluation">
            <summary> is a frequently used Attribute-type, it is used for representing the result of 
            an approval decision. The {@link Nbpm.Workflow.Delegation.ISerializer} for 
            Evaluation-objects is NetBpm.Workflow.Delegation.Impl.Serializer.EvaluationSerializer.
            To convert Evaluation-objects in NetBpm's web-interface to and from html, use 
            NetBpm.Workflow.Delegation.Impl.Htmlformatter.EvaluationInput as
            {@link Nbpm.Workflow.Delegation.IHtmlFormatter}  </summary>
        </member>
        <member name="T:NetBpm.Workflow.Definition.EComp.Impl.DefinitionEComp">
            <summary> reads the process-definition-jar-file (= process archive) and
            stores all content in the database. 
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.DeployProcessArchive(System.Byte[])">
            <summary> loads a process archive into the NetBpm engine.
            The contents of the process archive is parsed and stored in the database.
            A process archive contains one process definition.
            If a process definition with the same name already exists in the NetBpm-engine,
            the added definition will get a new version number (one higher then the highest
            existing version number for that name)
            </summary>
            <param name="processArchiveBytes">must be a byte-array that contains a process archive.  
            @throws JpdlException if the processArchiveStream does not contain a
            valid process archive. 
            </param>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.GetProcessDefinitions">
            <summary> collects the highest version of every {@link ProcessDefinition}. Those are the
            {@link ProcessDefinition}s from which a user must choose one to start.
            See also <a href="http://netbpm.org/docs/usersmanual.html#versioning">versioning</a>.
            </summary>
            <returns> a Collection of {@link NetBpm.Workflow.Definition.IProcessDefinition}s.  
            For each distinct process-definition-name it will return one ProcessDefinition : the 
            one with the highest version number.
            </returns>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.GetProcessDefinitions(NetBpm.Util.Client.Relations)">
            <summary> collects the highest version of every {@link ProcessDefinition}. Those are the
            {@link ProcessDefinition}s from which a user must choose one to start.
            </summary>
            <param name="relations">specifies which {@link Relations} should be resolved in the 
            returned {@link NetBpm.Workflow.Definition.IProcessDefinition}s
            </param>
            <returns> a Collection of {@link NetBpm.Workflow.Definition.IProcessDefinition}s.  
            For each distinct process-definition-name it will return one ProcessDefinition : the 
            one with the highest version number.
            </returns>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.GetProcessDefinition(System.String)">
            <summary> gets the latest version of the {@link NetBpm.Workflow.Definition.IProcessDefinition} with the given name.</summary>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.GetProcessDefinition(System.String,NetBpm.Util.Client.Relations)">
            <summary> gets the latest version of the {@link NetBpm.Workflow.Definition.IProcessDefinition} with the given name.</summary>
            <param name="relations">specifies which {@link Relations} should be resolved in the 
            returned {@link NetBpm.Workflow.Definition.IProcessDefinition}
            </param>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.GetProcessDefinition(System.Int64)">
            <summary> gets a specific version of a {@link NetBpm.Workflow.Definition.IProcessDefinition}.</summary>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.IDefinitionSessionLocal.GetProcessDefinition(System.Int64,NetBpm.Util.Client.Relations)">
            <summary> gets a specific version of a {@link NetBpm.Workflow.Definition.IProcessDefinition}.</summary>
            <param name="relations">specifies which {@link Relations} should be resolved in the 
            returned {@link NetBpm.Workflow.Definition.IProcessDefinition}
            </param>
        </member>
        <member name="M:NetBpm.Workflow.Definition.EComp.Impl.DefinitionEComp.DeployProcessArchive(System.Byte[])">
            <summary> this method is exposed only by the remote-interface and not the local-interface.</summary>
        </member>
        <member name="M:NetBpm.Workflow.Definition.Impl.NodeImpl.ValidateLeavingTransitions(NetBpm.Workflow.Definition.Impl.ValidationContext)">
            <summary> standard, a node must have at least one leaving transition.
            Only the EndStateImpl will have a different opinion on this :-)
            </summary>
        </member>
        <member name="P:NetBpm.Workflow.Definition.Impl.NodeImpl.TransitionDestinationScope">
            <summary> standard, the transition destination scope it the same scope as the node's scope.
            Only the JoinImpl will have a different opinion on this :-)
            </summary>
        </member>
        <member name="M:NetBpm.Workflow.Definition.Impl.DefinitionComponentImpl.ReadEntries(System.IO.Stream)">
            <summary> reads the zipFile-InputStream and puts all entries in a Map, for which
            the keys are the path-names.
            </summary>
            <returns> a Map with the entry-path-names as keys and the byte-arrays as the contents.
            </returns>
        </member>
        <member name="P:NetBpm.Workflow.Definition.Impl.DefinitionComponentImpl.Instance">
            <summary> gets the singleton instance.</summary>
        </member>
        <member name="T:NetBpm.Workflow.Definition.IEndState">
            <summary> is the end-state of a process-definition.</summary>
        </member>
        <member name="P:NetBpm.Workflow.Definition.Impl.JoinImpl.TransitionDestinationScope">
            <summary> overrides the standard scope, transitions of a join will arrive in the parent-processblock of the concurrent block.</summary>
        </member>
        <member name="T:NetBpm.Workflow.Definition.EventType">
            <summary> is the enum class for all runtime process execution events. </summary>
        </member>
        <member name="T:NetBpm.Workflow.Definition.NpdlException">
            <summary> is the checked exception that is thrown when a process archive
            is not compliant as specified in the NetBpm Process Defintition Language (nPdl).
            A JpdlException tries to collect as many error messages in one parsing or
            validation, analogue to a compiler.  This allows a process developer to 
            correct more then one problem before redeploying the process archive.  
            Each message is optionally composed of a list of sub-messages separated 
            by colons ':'. The sub-messages are ordered from general to specific.