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

All Superinterfaces:
DefinitionRecord, java.io.Serializable

public interface PackageDefinition
extends DefinitionRecord, java.io.Serializable

The concept of package is introduced by XPDL specification to act as a container for the grouping of common data entities from a number of different process definitions, to avoid redefinition within each individual process definition.
The package provides a container to hold a number of common attributes from the process definition entity (author,version, status, etc.).
Each process definition contained within the package will automatically inherit any common attributes from the package, unless they are separately re-specified locally within the process definition.


Nested Class Summary
static class PackageDefinition.GraphConformance
          The conformance class declaration allows description of the conformance class to which the definitions in this model definition are restricted.
static class PackageDefinition.PackageState
          Package state allow operations on the package itself and elements within it.
static class PackageDefinition.PublicationStatus
          Publication status of the Process Definition.
 
Method Summary
 java.lang.String getAuthor()
          Name of the author of this package definition.
 BusinessArchive getBusinessArchive()
           
 java.util.Set<java.lang.String> getClassDependencies()
          Returns class dependencies (java classDatas for hooks, mappers, performer assignments, deadlines) for this package.
 java.lang.String getCodepage()
          The codepage used for the text parts. if codepage is omitted, then UFT-8 is assumed.
 PackageDefinition.GraphConformance getConformanceClass()
          Returns the conformance class declaration.
 java.lang.String getCostUnit()
          Units used in Simulation Data (Usually expressed in terms of a currency)
 java.lang.String getCountrykey()
          Country code based on ISO 3166.
 java.lang.String getCreated()
          Creation date of Package Definition.
 java.lang.String getDeployedBy()
          Returns the user deploying the package.
 java.util.Date getDeployedDate()
          Returns the date when the package is deployed.
 java.lang.String getDescription()
          Textual description of the package
 java.lang.String getDocumentation()
          Operating System specific path- and filename of help file/description file.
 java.util.Set<ExternalPackageDefinition> getExternalPackages()
          Reference to another Package definition defined in a separate document.
 java.util.Set<java.lang.String> getPackageDependencies()
          If the package has subflows and the process definition for these subflows are defined in others package definitions then it is not possible to undeploy these packages until this package is itself undeployed.
 java.lang.String getPackageId()
          Returns the value of the id attribute of the Package element defined into the XPDL file.
 java.lang.String getPriorityUnit()
          A text string with user defined semantics.
 PackageDefinition.PublicationStatus getPublicationStatus()
          Returns the publication status of the Process Definition.
 java.util.Set<java.lang.String> getResponsibles()
          Participant, who is responsible for this process; the supervisor during run time Link to entity participant.
 java.lang.String getScriptGrammar()
          This is a reference to a document that specifies the grammar of the language.
 java.lang.String getScriptType()
          Identifies the scripting language used in expressions.
 java.lang.String getScriptVersion()
          This is the version of the scripting language.
 PackageDefinition.PackageState getState()
           
 java.util.Set<TypeDeclarationDefinition> getTypeDeclarations()
          A list of Data Types used in the package.
 java.lang.String getUndeployedBy()
          Returns the user undeploying the package.
 java.util.Date getUndeployedDate()
          Returns the date where the package is undeployed.
 PackageDefinitionUUID getUUID()
          Returns the UUID for the PackageDefinition.
 java.lang.String getVendor()
          Defines the origin of this model definition and contains vendor's name, vendor's product name and product's release number.
 java.lang.String getVersion()
          Version of this Package Definition.
 java.lang.String getXPDLVersion()
          Returns the version of the XPDL specification supported by the workflow engine.
 
Methods inherited from interface org.ow2.bonita.facade.def.majorElement.DefinitionRecord
getName, getPackageDefinitionUUID
 

Method Detail

getUUID

PackageDefinitionUUID getUUID()
Returns the UUID for the PackageDefinition.


getPackageId

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


getDeployedDate

java.util.Date getDeployedDate()
Returns the date when the package is deployed.


getUndeployedDate

java.util.Date getUndeployedDate()
Returns the date where the package is undeployed.


getDeployedBy

java.lang.String getDeployedBy()
Returns the user deploying the package.


getUndeployedBy

java.lang.String getUndeployedBy()
Returns the user undeploying the package.


getXPDLVersion

java.lang.String getXPDLVersion()
Returns the version of the XPDL specification supported by the workflow engine.

Returns:
The version of the XPDL specification supported by the workflow engine.

getVendor

java.lang.String getVendor()
Defines the origin of this model definition and contains vendor's name, vendor's product name and product's release number.


getCreated

java.lang.String getCreated()
Creation date of Package Definition.


getDescription

java.lang.String getDescription()
Textual description of the package


getDocumentation

java.lang.String getDocumentation()
Operating System specific path- and filename of help file/description file.


getPriorityUnit

java.lang.String getPriorityUnit()
A text string with user defined semantics.


getCostUnit

java.lang.String getCostUnit()
Units used in Simulation Data (Usually expressed in terms of a currency)


getAuthor

java.lang.String getAuthor()
Name of the author of this package definition.


getVersion

java.lang.String getVersion()
Version of this Package Definition.


getCodepage

java.lang.String getCodepage()
The codepage used for the text parts. if codepage is omitted, then UFT-8 is assumed.


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.


getResponsibles

java.util.Set<java.lang.String> getResponsibles()
Participant, who is responsible for this process; the supervisor during run time Link to entity participant. Participant, who is responsible for this workflow of this Model definition (usually an Organisational Unit or a Human). It is assumed that the responsible is the supervisor during run time. Default: Initiating participant.


getPublicationStatus

PackageDefinition.PublicationStatus getPublicationStatus()
Returns the publication status of the Process Definition.


getConformanceClass

PackageDefinition.GraphConformance getConformanceClass()
Returns the conformance class declaration.


getScriptType

java.lang.String getScriptType()
Identifies the scripting language used in expressions. For consistency across implementations, when specifying a standard scripting language, it is recommended that the Type be selected from the following strings: text/javascript, text/vbscript, text/tcl, text/ecmascript, text/xml.


getScriptVersion

java.lang.String getScriptVersion()
This is the version of the scripting language.


getScriptGrammar

java.lang.String getScriptGrammar()
This is a reference to a document that specifies the grammar of the language. It could be, for example, an XML schema, a DTD, or a BNF.


getExternalPackages

java.util.Set<ExternalPackageDefinition> getExternalPackages()
Reference to another Package definition defined in a separate document.


getTypeDeclarations

java.util.Set<TypeDeclarationDefinition> getTypeDeclarations()
A list of Data Types used in the package. See section 7.13 of xpdl 1 specification from Wfmc.


getPackageDependencies

java.util.Set<java.lang.String> getPackageDependencies()
If the package has subflows and the process definition for these subflows are defined in others package definitions then it is not possible to undeploy these packages until this package is itself undeployed.

Returns:
The (unordered) set of package processDefinitionUUID depending on this package definition.

getClassDependencies

java.util.Set<java.lang.String> getClassDependencies()
Returns class dependencies (java classDatas for hooks, mappers, performer assignments, deadlines) for this package.

Returns:
The (unordered) set of classDatas on which this package depends on.

getBusinessArchive

BusinessArchive getBusinessArchive()

getState

PackageDefinition.PackageState getState()


Copyright © 2009 OW2 Consortium. All Rights Reserved.