Package (onecode-esdstudio 1.1.2 API)

java.lang.Object
- com.ds.bpm.bpd.xml.XMLElement
- - com.ds.bpm.bpd.xml.XMLComplexElement
  - - com.ds.bpm.bpd.xml.elements.Package

所有已实现的接口:

Serializable, Cloneable
```
public class Package
extends XMLComplexElement
```
Represents the main element of WfMC schema. 包对象类，流程XML文件的根节点元素

另请参阅:

序列化表格

字段概要
- 从类继承的字段 com.ds.bpm.bpd.xml.XMLComplexElement
  attributes, complexStructure
- 从类继承的字段 com.ds.bpm.bpd.xml.XMLElement
  atts, isCollapsed, isReadOnly, isRequired, isVisible, labelName, name, NEWLINE, OFFSET, value

构造器概要

构造器
构造器和说明

Package(XMLInterface xmlInterface)
Creates a new instance of the class.

构造器
构造器和说明
`Package(XMLInterface xmlInterface)` Creates a new instance of the class.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addExternalPackage(Package externalPkg)` Adds single external package to collection of external packages.
`void`	`addExternalPackages(Package externalPkg)` Adds to collection of external packages the all packages that given external package references.
`protected void`	`addPropertyToAllActivities(UserProperty up)`
`void`	`afterImporting()` Called after importing of XML file to insert entities from external packages, to set the proper Participant objects for Responsibles of Package and for every WorkflowProcess within a Package, according on Responsible ID's read from XML.
`protected boolean`	`canRemoveExternalPackage(ExternalPackage ep)` Checks if some entities from specified external package (and all packages that it references - except one that are referenced in some other way (e.g. cross-reference, or duplicated reference)) are in use by this package elements.
`boolean`	`equals(Object o)`
`protected void`	`fillStructure()` Defines the super-class method.
`void`	`fromXML(Node node)` Overrides super-class method to realize this class specific reading from XML file.
`Set`	`getAllExternalPackages()` Returns a hashtable.
`String`	`getCurrentVersion()` Indicates which is the current version of BPD.
`XMLPanel`	`getPanel()` Prepares the tabbed panel to show editable fields of Package.
`XMLPanel`	`getPanel(int no)` Prepares the one of the group panels that contains some of this element editable fields.
`DefaultTreeModel`	`getTreeModel()`
`UserProperties`	`getUserDefinedActivityProperties()` Returns all user defined activity properties within this package instance.
`String`	`getVersion()` Indicates which version of BPD was package made by.
`WorkflowProcess`	`getWorkflowProcess(String ID)` Returns a workflow process with specified ID.
`XMLInterface`	`getXMLInterface()`
`protected void`	`insertFromExternal(ExternalPackage ep)` Collects information about all newly inserted external packages, which root package is specified one, and which wasn't inserted until now.
`boolean`	`isMadeByBPD()` Indicates if package read from XML document) is made by BPD
`boolean`	`isValidEnter(XMLPanel p)` Indicates if dialog data enter for element is valid.
`void`	`refreshLabelName()`
`protected void`	`refreshMandatories(UserProperty up)`
`protected void`	`removeExternal(ExternalPackage ep)`
`protected void`	`removePropertyFromAllActivities(UserProperty up)`
`void`	`setIDPrefixForCollections()` Sets proper ID prefix for all Id generators (XMLCollection class instances).
`void`	`setReadOnly(boolean ro)` Sets the element and all elements it is made of to be read only or not.
`String`	`toString()` Overrides super-class method to retreive the value of this class "Id" attribute.
`void`	`toXML(Node parent)` Overrides super-class method to realize this class specific writting to XML file.

从类继承的方法 com.ds.bpm.bpd.xml.XMLComplexElement
clone, get, get, getChildElements, getElementsCount, getIndex, getNode, isEmpty, isValid, processAttributes, processElements, set, set, toComplexType, toComplexTypeValues, toComplexValues

从类继承的方法 com.ds.bpm.bpd.xml.XMLElement
fromXML, getPrintDescription, getPrintDescription, isCollapsed, isReadOnly, isRequired, isVisible, setCollapsed, setLabelName, setRequired, setValue, setVisible, toLabel, toName, toValue

从类继承的方法 java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - Package
```
public Package(XMLInterface xmlInterface)
```
    Creates a new instance of the class.
- 方法详细资料
  - fillStructure
```
protected void fillStructure()
```
    Defines the super-class method. Read the explanation for this method within XMLComplexElement class.
    
    覆盖:
    
    fillStructure 在类中 XMLComplexElement
  - setReadOnly
```
public void setReadOnly(boolean ro)
```
    从类复制的说明: XMLComplexElement
    
    Sets the element and all elements it is made of to be read only or not.
    
    覆盖:
    
    setReadOnly 在类中 XMLComplexElement
    
    参数:
    
    ro - true if element will be 'read only', false otherwise.
  - isMadeByBPD
```
public boolean isMadeByBPD()
```
    Indicates if package read from XML document) is made by BPD
    
    返回:
    
    true if package is made by BPD, false otherwise.
  - getVersion
```
public String getVersion()
```
    Indicates which version of BPD was package made by.
  - getCurrentVersion
```
public String getCurrentVersion()
```
    Indicates which is the current version of BPD.
  - insertFromExternal
```
protected void insertFromExternal(ExternalPackage ep)
```
    Collects information about all newly inserted external packages, which root package is specified one, and which wasn't inserted until now.
  - getTreeModel
```
public DefaultTreeModel getTreeModel()
```
  - canRemoveExternalPackage
```
protected boolean canRemoveExternalPackage(ExternalPackage ep)
```
    Checks if some entities from specified external package (and all packages that it references - except one that are referenced in some other way (e.g. cross-reference, or duplicated reference)) are in use by this package elements.
    
    返回:
    
    true if external reference can be removed (case when it's entities are not in use), false otherwise.
  - removeExternal
```
protected void removeExternal(ExternalPackage ep)
```
  - getUserDefinedActivityProperties
```
public UserProperties getUserDefinedActivityProperties()
```
    Returns all user defined activity properties within this package instance.
    
    返回:
    
    User defined activity properties for Package.
  - addPropertyToAllActivities
```
protected void addPropertyToAllActivities(UserProperty up)
```
  - removePropertyFromAllActivities
```
protected void removePropertyFromAllActivities(UserProperty up)
```
  - refreshMandatories
```
protected void refreshMandatories(UserProperty up)
```
  - getWorkflowProcess
```
public WorkflowProcess getWorkflowProcess(String ID)
```
    Returns a workflow process with specified ID.
    NOTE: This method should be called immediately after import of an XML file (during a creation of graph), otherwise it may not give the desired result.
    
    参数:
    
    ID - The 'Id' attribute of wanted instance of WorkflowProcess element defined within a XML file.
    
    返回:
    
    Returns the instance of WorkflowProcess element that have the specified ID as an 'Id' attribute if it exist among all defined processes within package, if it doesn't exist, null is returned.
  - toString
```
public String toString()
```
    Overrides super-class method to retreive the value of this class "Id" attribute. This is used when displaying instance of this class within dialog.
    
    覆盖:
    
    toString 在类中 XMLComplexElement
    
    返回:
    
    The "Id" attribute value of this class.
  - getPanel
```
public XMLPanel getPanel(int no)
```
    Prepares the one of the group panels that contains some of this element editable fields.
    
    参数:
    
    no - The ordinal number of group panel to be shown.
    
    返回:
    
    XMLPanel to be shown.
  - getPanel
```
public XMLPanel getPanel()
```
    Prepares the tabbed panel to show editable fields of Package. Panel consists of nine tabs that logically comprises the Package elements to be edited.
    NOTE: This method is never used, panels are retrieved one by one calling the method with the same name but with ordinal number of wanted panel as an argument.
    
    覆盖:
    
    getPanel 在类中 XMLComplexElement
    
    返回:
    
    XMLPanel to be shown.
  - toXML
```
public void toXML(Node parent)
           throws DOMException
```
    Overrides super-class method to realize this class specific writting to XML file.
    
    覆盖:
    
    toXML 在类中 XMLComplexElement
    
    参数:
    
    parent - The Node of XML file,
    
    抛出:
    
    DOMException
  - fromXML
```
public void fromXML(Node node)
```
    Overrides super-class method to realize this class specific reading from XML file. 把XML Document对象转换成element元素
    
    覆盖:
    
    fromXML 在类中 XMLComplexElement
    
    参数:
    
    node - The Node of XML file, that represents tag for this element.
  - setIDPrefixForCollections
```
public void setIDPrefixForCollections()
```
    Sets proper ID prefix for all Id generators (XMLCollection class instances).
  - getAllExternalPackages
```
public Set getAllExternalPackages()
```
    Returns a hashtable. The keys are external packages of this package, and values are Integers that describes the depth of external package within current package.
  - addExternalPackages
```
public void addExternalPackages(Package externalPkg)
```
    Adds to collection of external packages the all packages that given external package references.
  - addExternalPackage
```
public void addExternalPackage(Package externalPkg)
```
    Adds single external package to collection of external packages.
  - afterImporting
```
public void afterImporting()
```
    Called after importing of XML file to insert entities from external packages, to set the proper Participant objects for Responsibles of Package and for every WorkflowProcess within a Package, according on Responsible ID's read from XML.
  - refreshLabelName
```
public void refreshLabelName()
```
    覆盖:
    
    refreshLabelName 在类中 XMLComplexElement
  - isValidEnter
```
public boolean isValidEnter(XMLPanel p)
```
    从类复制的说明: XMLElement
    
    Indicates if dialog data enter for element is valid. This implementation claims that element is always valid. The derived classes has to implement it's own definition of validity.
    
    覆盖:
    
    isValidEnter 在类中 XMLElement
    
    返回:
    
    true if dialog data for the element are valid, false otherwise.
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - getXMLInterface
```
public XMLInterface getXMLInterface()
```

类 Package

字段概要

从类继承的字段 com.ds.bpm.bpd.xml.XMLComplexElement

从类继承的字段 com.ds.bpm.bpd.xml.XMLElement

构造器概要

方法概要

从类继承的方法 com.ds.bpm.bpd.xml.XMLComplexElement

从类继承的方法 com.ds.bpm.bpd.xml.XMLElement

从类继承的方法 java.lang.Object

构造器详细资料

Package

方法详细资料

fillStructure

setReadOnly

isMadeByBPD

getVersion

getCurrentVersion

insertFromExternal

getTreeModel

canRemoveExternalPackage

removeExternal

getUserDefinedActivityProperties

addPropertyToAllActivities

removePropertyFromAllActivities

refreshMandatories

getWorkflowProcess

toString

getPanel

getPanel

toXML

fromXML

setIDPrefixForCollections

getAllExternalPackages

addExternalPackages

addExternalPackage

afterImporting

refreshLabelName

isValidEnter

equals

getXMLInterface