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

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

public interface PackageDef
extends DefinitionRecord, Record, java.io.Serializable


Nested Class Summary
static class PackageDef.GraphConformance
           
static class PackageDef.PackageState
           
static class PackageDef.PublicationStatus
           
 
Method Summary
 java.lang.String getAuthor()
          Name of the author of this package definition.
 java.util.Set<java.lang.String> getClassDependencies()
          Returns class dependencies (java classes for hooks, mappers, performer assignments) for this package.
 java.lang.String getCodepage()
          The codepage used for the text parts. if codepage is omitted, then UFT-8 is assumed.
 PackageDef.GraphConformance getConformanceClass()
          FULL-BLOCKED The network structure is restricted to proper nesting of SPLIT/JOIN and loops.
 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 getDeploymentId()
          A package can be deployed and then undeployed several times.
 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<org.ow2.bonita.facade.def.element.ExternalPackageDef> 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 getPriorityUnit()
          A text string with user defined semantics.
 PackageDef.PublicationStatus getPublicationStatus()
          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.
 java.util.Set<org.ow2.bonita.facade.def.element.TypeDeclarationDef> 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.
 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
 
Methods inherited from interface org.ow2.bonita.facade.Record
getId, getPackageId
 

Method Detail

getDeploymentId

java.lang.String getDeploymentId()
Description copied from interface: Record
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.

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

PackageDef.PublicationStatus getPublicationStatus()
Status of the Process Definition. UNDER_REVISION RELEASED UNDER_TEST


getConformanceClass

PackageDef.GraphConformance getConformanceClass()
FULL-BLOCKED The network structure is restricted to proper nesting of SPLIT/JOIN and loops. LOOP-BLOCKED The network structure is restricted to proper nesting of loops. NON-BLOCKED There is no restriction on the network structure. This is the default.


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<org.ow2.bonita.facade.def.element.ExternalPackageDef> getExternalPackages()
Reference to another Package definition defined in a separate document.


getTypeDeclarations

java.util.Set<org.ow2.bonita.facade.def.element.TypeDeclarationDef> 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 id depending on this package definition.

getClassDependencies

java.util.Set<java.lang.String> getClassDependencies()
Returns class dependencies (java classes for hooks, mappers, performer assignments) for this package. Return The (unordered) set of classes on which this package depends on.