org.ow2.bonita.facade.def.majorElement
Interface ProcessDef

All Superinterfaces:
DefinitionRecord, Record, java.io.Serializable
All Known Subinterfaces:
ProcessFullDef

public interface ProcessDef
extends DefinitionRecord, java.io.Serializable


Nested Class Summary
static class ProcessDef.AccessLevel
           
static class ProcessDef.DurationUnit
           
static class ProcessDef.ProcessState
           
 
Method Summary
 ProcessDef.AccessLevel getAccessLevel()
          The Access level of a process may be either PUBLIC or PRIVATE.
 java.lang.String getAuthor()
          Name of the author of this process definition.
 java.lang.String getCodepage()
          The codepage used for the text parts.
 java.lang.String getCountrykey()
          Country code based on ISO 3166.
 java.lang.String getCreated()
          Creation date of process definition.
 java.lang.String getDeploymentId()
          A package can be deployed and then undeployed several times.
 java.lang.String getDescription()
          Short textual description of the process.
 ProcessDef.DurationUnit getDurationUnit()
          Describes the default unit to be applied to an integer duration value that has no unit tag.
 java.util.List<org.ow2.bonita.facade.def.element.FormalParameterDef> getFormalParameters()
          A list of parameters that may be passed to the process.
 java.lang.String getLimit()
          Expected duration for time management purposes (e.g. starting an escalation procedure etc.) in units of DurationUnit.
 java.lang.String getPackageId()
          Returns the value of the package Id attribute defined into the xpdl file.
 java.lang.String getPriority()
          The priority of the process type.
 PackageDef.PublicationStatus getPublicationStatus()
          Status of the Process Definition.
 java.util.Set<java.lang.String> getResponsibles()
          Participant, who is responsible for this process (usually an Organisational Unit or a Human).
 org.ow2.bonita.facade.def.element.TimeEstimationDef getTimeEstimation()
          Grouping of waiting time, working time, and duration.
 java.lang.String getValidFrom()
          The date that the process definition is active from.
 java.lang.String getValidTo()
          The date at which the process definition becomes valid.
 java.lang.String getVersion()
          Version of this process definition.
 
Methods inherited from interface org.ow2.bonita.facade.def.majorElement.DefinitionRecord
getName
 
Methods inherited from interface org.ow2.bonita.facade.Record
getId
 

Method Detail

getPackageId

java.lang.String getPackageId()
Returns the value of the package Id attribute defined into the xpdl file.

Specified by:
getPackageId in interface Record
Returns:
The package id.

getDeploymentId

java.lang.String getDeploymentId()
A package can be deployed and then undeployed several times. Each deployment can be uniquely identified by the deployment id.

Specified by:
getDeploymentId in interface Record
Returns:
The deployment id.

getAccessLevel

ProcessDef.AccessLevel getAccessLevel()
The Access level of a process may be either PUBLIC or PRIVATE. If PUBLIC the process may be invoked by an external system or application. A process with private access may only be invoked from a SubFlow Activity.
Use is optional and default is PUBLIC.


getCreated

java.lang.String getCreated()
Creation date of process definition.


getDescription

java.lang.String getDescription()
Short textual description of the process.


getPriority

java.lang.String getPriority()
The priority of the process type. The units are defined in the Package header priority units.


getLimit

java.lang.String getLimit()
Expected duration for time management purposes (e.g. starting an escalation procedure etc.) in units of DurationUnit. It is counted from the starting date/time of the Process. The consequences of reaching the limit value are not defined in this document (i.e. vendor specific). It is assumed that in this case at least the Responsible of the current process is notified of this situation.


getValidFrom

java.lang.String getValidFrom()
The date that the process definition is active from. Empty string means system date.
Default: Inherited from Model Definition.


getValidTo

java.lang.String getValidTo()
The date at which the process definition becomes valid. Empty string means unlimited validity.
Default: Inherited from Model Definition.


getTimeEstimation

org.ow2.bonita.facade.def.element.TimeEstimationDef getTimeEstimation()
Grouping of waiting time, working time, and duration. Used for simulation purposes.


getDurationUnit

ProcessDef.DurationUnit getDurationUnit()
Describes the default unit to be applied to an integer duration value that has no unit tag. Possible units are:


getAuthor

java.lang.String getAuthor()
Name of the author of this process definition. (The one, who put it into the repository)


getVersion

java.lang.String getVersion()
Version of this process definition.


getCodepage

java.lang.String getCodepage()
The codepage used for the text parts.
Default: Inherited from Model Definition.


getCountrykey

java.lang.String getCountrykey()
Country code based on ISO 3166. It could be either the three digits country code number, or the two alpha characters country codes.
Default: Inherited from Model Definition.


getResponsibles

java.util.Set<java.lang.String> getResponsibles()
Participant, who is responsible for this process (usually an Organisational Unit or a Human). It is assumed that the responsible is the supervisor during execution of the process.
Default: Inherited from Model Definition.


getPublicationStatus

PackageDef.PublicationStatus getPublicationStatus()
Status of the Process Definition.
Default: Inherited from Model Definition.
UNDER_REVISION RELEASED UNDER_TEST


getFormalParameters

java.util.List<org.ow2.bonita.facade.def.element.FormalParameterDef> getFormalParameters()
A list of parameters that may be passed to the process.