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

All Superinterfaces:
DefinitionRecord, ProcessDefinitionRecord, java.io.Serializable

public interface ProcessDefinition
extends ProcessDefinitionRecord, java.io.Serializable

This interface represents the Process definition. It's derived from the WorkflowProcess of XPDL.


Nested Class Summary
static class ProcessDefinition.AccessLevel
          Not supported.
static class ProcessDefinition.DurationUnit
          Duration unit: Year, Month, Day, hours, minutes, seconds
static class ProcessDefinition.ProcessState
          Workflow process state.
 
Method Summary
 ProcessDefinition.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 getDescription()
          Short textual description of the process.
 ProcessDefinition.DurationUnit getDurationUnit()
          Describes the default unit to be applied to an integer duration value that has no unit tag.
 java.util.List<FormalParameterDefinition> 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 getPriority()
          The priority of the process type.
 java.lang.String getProcessId()
          Returns the value of the id attribute of the WorkflowProcess element defined into the XPDL file.
 PackageDefinition.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).
 TimeEstimationDefinition getTimeEstimation()
          Grouping of waiting time, working time, and duration.
 ProcessDefinitionUUID getUUID()
          Returns the UUID for the ProcessDefinition.
 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.ProcessDefinitionRecord
getProcessDefinitionUUID
 
Methods inherited from interface org.ow2.bonita.facade.def.majorElement.DefinitionRecord
getName, getPackageDefinitionUUID
 

Method Detail

getUUID

ProcessDefinitionUUID getUUID()
Returns the UUID for the ProcessDefinition.


getProcessId

java.lang.String getProcessId()
Returns the value of the id attribute of the WorkflowProcess element defined into the XPDL file.


getAccessLevel

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

TimeEstimationDefinition getTimeEstimation()
Grouping of waiting time, working time, and duration. Used for simulation purposes.


getDurationUnit

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

PackageDefinition.PublicationStatus getPublicationStatus()
Status of the Process Definition.
Default: Inherited from Model Definition.


getFormalParameters

java.util.List<FormalParameterDefinition> getFormalParameters()
A list of parameters that may be passed to the process.



Copyright © 2008 OW2 Consortium. All Rights Reserved.