Activity (onecode-esdstudio 1.0.8 API)

java.lang.Object
- com.ds.bpm.bpd.xml.XMLElement
- - com.ds.bpm.bpd.xml.XMLComplexElement
  - - com.ds.bpm.bpd.xml.XMLCollectionElement
    - - com.ds.bpm.bpd.xml.activity.Activity

所有已实现的接口:

Serializable, Cloneable
```
public class Activity
extends XMLCollectionElement
```
Represents a WfMC DTD element that has the similar name. An object of this class is attribute of class com.ds.bpm.bpd.graph.Activity, which is visual representation of this class. 活动元素类

另请参阅:

序列化表格

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

构造器概要

构造器
构造器和说明
`Activity(Activities acts, WorkflowProcess myWorkflow, ActivityDefTypeEnums type)` Constructs an Activity object that will be contained within a given workflow process, and of specified type.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addUserProperty(UserProperty up)` Adds an user defined property to the activity.
`protected void`	`afterImporting()`
`protected void`	`afterImporting(boolean importUserProperties)` Called by Package object after importing of XML file to set the proper Participant objects for performer of activity, according on it's ID read from XML, to set proper reference to workflow process for activities of Subflow type, and to set proper user defined activity properties.
`Object`	`clone()` Used when copying activities of Application(Tools) and AutoActivity type.
`Activity`	`clonePlugins(Activity act)`
`protected void`	`fillOutgoingTransitions()`
`protected void`	`fillStructure()` Defines the super-class method.
`void`	`fromXML(Node node)` Supposed to be overriden by derived classes to implement element specific reading from an XML file.
`ActivityEventBase`	`getActivityEvent()` Returns a workflow process that contains activity.
`XMLAttribute`	`getAttrName()`
`BlockActivity`	`getBlockActivity()`
`Devices`	`getDevices()`
`Set`	`getEndDescriptions()`
`Events`	`getEvents()`
`Set`	`getIncomingTransitions()`
`Join`	`getJoin()` Used to retrieve Join element.
`Set`	`getNonExceptionalOutgoingTransitions()`
`OutFlow`	`getOutflow()`
`WorkflowProcess`	`getOwnerProcess()` Returns a workflow process that contains activity.
`XMLPanel`	`getPanel()` Prepares the tabbed panel to show editable fields of Activity.
`String`	`getParticipantID()`
`Object`	`getProperty(String key)`
`Services`	`getServices()`
`Split`	`getSplit()` Used to retrieve Split element.
`Set`	`getStartDescriptions()`
`SubFlow`	`getSubflow()`
`Tools`	`getTools()`
`String`	`getTooltip()` Gets the tooltip for activity.
`ActivityDefTypeEnums`	`getType()` Returns an activity type.
`String`	`getVisuallySortedParticipantIDs()` Used to get the visual order of participant visual objects contained within a BlockActivity graph.
`int`	`getXOffset()` Called to get the visual position of Activity.
`int`	`getYOffset()` Called to get the visual position of Activity.
`boolean`	`isIDUniqueAndValid(XMLPanel tabbedPanel)` Checks if an ID entered by the user is unique.
`boolean`	`isValidEnter(XMLPanel p)` If activity type is SubFlow, checks if actual and formal params are matched by type and number.
`void`	`refreshLabelName()`
`void`	`refreshMandatories(UserProperty up)` Adds an user defined property after the user changed it's type from `OPTIONAL` to `MANDATORY`.
`void`	`refreshPlugins()`
`void`	`removeUserProperty(UserProperty up)` Removes an user defined property upon it's removal from collection of properties.
`void`	`setActivityEvent(ActivityEventBase activityEvent)`
`void`	`setAttrName(XMLAttribute attrName)`
`protected void`	`setCollection(Activities newCollection)` Used to set the collection that activity belongs to.
`void`	`setEndDescriptions(Set eds)`
`void`	`setJoinType(String type)` Sets the Join restriction type of activity.
`void`	`setOutgoingTransitions(Set ts)`
`void`	`setParticipantID(String pID)`
`void`	`setPosition(String position)`
`void`	`setProperty(String key, Object obj)`
`void`	`setReadOnly(boolean ro)` Sets the element and all elements it is made of to be read only or not.
`void`	`setSplitType(String type)` Sets the Split restriction type of activity.
`void`	`setStartDescriptions(Set sd)`
`void`	`setVisuallySortedParticipantIDs(String vsPID)` Used to set the visual order of participant visual objects contained within a BlockActivity graph.
`void`	`setWorkflowProcess(WorkflowProcess wp)`
`void`	`setXOffset(int xOffs)` Called to set the visual position of Activity.
`void`	`setYOffset(int yOffs)` Called to set the visual position of Activity.
`String`	`toString()` Overrides `toString` method to return the name of Activity.
`void`	`toXML(Node parent)` Overrides super-class method to realize this class specific writting to XML file.

从类继承的方法 com.ds.bpm.bpd.xml.XMLCollectionElement
getCollection, getID, getNode, setCollection

从类继承的方法 com.ds.bpm.bpd.xml.XMLComplexElement
get, get, getChildElements, getElementsCount, getIndex, 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
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - Activity
```
public Activity(Activities acts,
                WorkflowProcess myWorkflow,
                ActivityDefTypeEnums type)
```
    Constructs an Activity object that will be contained within a given workflow process, and of specified type.
    These are valid types:
    - 0 - route activity type
    - 1 - no activity type (activity that doesn't have implementation)
    - 2 - tool activity type (activity that implements some applications)
    - 3 - subflow activity type
    - 4 - block activity type
    参数:
    
    acts - The reference to collection of activities where this instance will be put into.
    
    myWorkflow - The workflow process that contains activity.
    
    type - The type of activity.
- 方法详细资料
  - getOwnerProcess
```
public WorkflowProcess getOwnerProcess()
```
    Returns a workflow process that contains activity.
    
    返回:
    
    The workflow process that ownes activity.
  - getActivityEvent
```
public ActivityEventBase getActivityEvent()
```
    Returns a workflow process that contains activity.
    
    返回:
    
    The workflow process that ownes activity.
  - setActivityEvent
```
public void setActivityEvent(ActivityEventBase activityEvent)
```
  - fromXML
```
public void fromXML(Node node)
```
    从类复制的说明: XMLElement
    
    Supposed to be overriden by derived classes to implement element specific reading from an XML file. This implementation satisfies only "simple" elements. 把XML元素转化成值对象
    
    覆盖:
    
    fromXML 在类中 XMLCollectionElement
    
    参数:
    
    node - The content retrieved from XML file, that represents tag for this element.
  - afterImporting
```
protected void afterImporting()
```
  - afterImporting
```
protected void afterImporting(boolean importUserProperties)
```
    Called by Package object after importing of XML file to set the proper Participant objects for performer of activity, according on it's ID read from XML, to set proper reference to workflow process for activities of Subflow type, and to set proper user defined activity properties.
  - getStartDescriptions
```
public Set getStartDescriptions()
```
  - setStartDescriptions
```
public void setStartDescriptions(Set sd)
```
  - getEndDescriptions
```
public Set getEndDescriptions()
```
  - setEndDescriptions
```
public void setEndDescriptions(Set eds)
```
  - getVisuallySortedParticipantIDs
```
public String getVisuallySortedParticipantIDs()
```
    Used to get the visual order of participant visual objects contained within a BlockActivity graph.
    NOTE: This order is valid only immediately after import of WorkflowProcess or it's export to XML file, also, this order is an ExtendedAttribute in a WfMC DTD sence, so it is valid only for XMLs saved by this version of the BPD application.
    
    返回:
    
    String representation of visually sorted participant ID's.
  - setVisuallySortedParticipantIDs
```
public void setVisuallySortedParticipantIDs(String vsPID)
```
    Used to set the visual order of participant visual objects contained within a BlockActivity graph.
    
    参数:
    
    vsPID - String representation of visually sorted participant ID's.
  - getXOffset
```
public int getXOffset()
```
    Called to get the visual position of Activity.
    
    返回:
    
    X-offset in respect to origin of Participant's graph object that visually holds activity.
  - setXOffset
```
public void setXOffset(int xOffs)
```
    Called to set the visual position of Activity.
    
    参数:
    
    xOffs - X-offset in respect to origin of Participant's graph object that visually holds activity.
  - getYOffset
```
public int getYOffset()
```
    Called to get the visual position of Activity.
    
    返回:
    
    Y-offset in respect to origin of Participant's graph object that visually holds activity.
  - setYOffset
```
public void setYOffset(int yOffs)
```
    Called to set the visual position of Activity.
    
    参数:
    
    yOffs - Y-offset in respect to origin of Participant's graph object that visually holds activity.
  - getParticipantID
```
public String getParticipantID()
```
    返回:
    
    String representation of ID of participant that visualy contains activity.
  - setParticipantID
```
public void setParticipantID(String pID)
```
    参数:
    
    pID - String representation of ID of participant that visualy contains activity.
  - setOutgoingTransitions
```
public void setOutgoingTransitions(Set ts)
```
  - getType
```
public ActivityDefTypeEnums getType()
```
    Returns an activity type.
    These are possible types:
    - 0 - route activity type
    - 1 - no activity type (activity that doesn't have implementation)
    - 2 - tool activity type (activity that implements some applications)
    - 3 - subflow activity type
    - 4 - block activity type
    返回:
    
    The integer value that represents the type of activity.
  - setJoinType
```
public void setJoinType(String type)
```
    Sets the Join restriction type of activity. This is called by WorkflowProcess after importing of an XML but only if activity is the first activity of block activity.
    
    参数:
    
    type - The type of Join, which can be AND or XOR.
  - getJoin
```
public Join getJoin()
```
    Used to retrieve Join element.
    
    返回:
    
    Join element.
  - setSplitType
```
public void setSplitType(String type)
```
    Sets the Split restriction type of activity. This is called by WorkflowProcess after importing of an XML but only if activity is the last activity of block activity.
    
    参数:
    
    type - The type of Split, which can be AND or XOR.
  - getSplit
```
public Split getSplit()
```
    Used to retrieve Split element.
    
    返回:
    
    Split element.
  - getTools
```
public Tools getTools()
```
  - getSubflow
```
public SubFlow getSubflow()
```
  - getOutflow
```
public OutFlow getOutflow()
```
  - getServices
```
public Services getServices()
```
  - getDevices
```
public Devices getDevices()
```
  - getEvents
```
public Events getEvents()
```
  - getBlockActivity
```
public BlockActivity getBlockActivity()
```
  - fillStructure
```
protected void fillStructure()
```
    Defines the super-class method. Read the explanation for this method within XMLComplexElement class.
    
    覆盖:
    
    fillStructure 在类中 XMLCollectionElement
  - getPanel
```
public XMLPanel getPanel()
```
    Prepares the tabbed panel to show editable fields of Activity. Panel consists of six tabs that logically comprises the Activity elements to be edited. 活动展示Panel
    
    覆盖:
    
    getPanel 在类中 XMLComplexElement
    
    返回:
    
    XMLPanel to be shown.
  - fillOutgoingTransitions
```
protected void fillOutgoingTransitions()
```
  - addUserProperty
```
public void addUserProperty(UserProperty up)
```
    Adds an user defined property to the activity. This is used when the new Activity is created by inserting it's visual object into the graph, to set all mandatory user properties defined, or when the new mandatory property is created.
    
    参数:
    
    up - The mandatory user property to add.
  - removeUserProperty
```
public void removeUserProperty(UserProperty up)
```
    Removes an user defined property upon it's removal from collection of properties.
    
    参数:
    
    up - The user property to remove.
  - refreshMandatories
```
public void refreshMandatories(UserProperty up)
```
    Adds an user defined property after the user changed it's type from OPTIONAL to MANDATORY.
    
    参数:
    
    up - The mandatory user property to add.
  - toString
```
public String toString()
```
    Overrides toString method to return the name of Activity. This string is used to visually display the activity name onto it's graph object.
    
    覆盖:
    
    toString 在类中 XMLComplexElement
    
    返回:
    
    The activity name attribute.
  - getTooltip
```
public String getTooltip()
```
    Gets the tooltip for activity. The tooltip consists of property names and values.
    
    返回:
    
    The tooltip to be displayed when user holds the mouse above activity's graph object.
  - toXML
```
public void toXML(Node parent)
           throws DOMException
```
    Overrides super-class method to realize this class specific writting to XML file.
    
    覆盖:
    
    toXML 在类中 XMLComplexElement
    
    参数:
    
    parent - indicates how much tabulators to put before element tag.
    
    抛出:
    
    DOMException
  - 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.
  - clone
```
public Object clone()
```
    Used when copying activities of Application(Tools) and AutoActivity type. The newly created activity will have all properties same as the copied one, except that it will have diferent ID.
    
    覆盖:
    
    clone 在类中 XMLCollectionElement
    
    返回:
    
    The newly created Activity object.
  - refreshLabelName
```
public void refreshLabelName()
```
    覆盖:
    
    refreshLabelName 在类中 XMLComplexElement
  - isIDUniqueAndValid
```
public boolean isIDUniqueAndValid(XMLPanel tabbedPanel)
```
    Checks if an ID entered by the user is unique.
    
    覆盖:
    
    isIDUniqueAndValid 在类中 XMLCollectionElement
  - isValidEnter
```
public boolean isValidEnter(XMLPanel p)
```
    If activity type is SubFlow, checks if actual and formal params are matched by type and number. This method is called only if user presses OK button within the dialog for editing Activity properties, so the changes to the user property collection as well as the changes in the tool collection (if activity type is tool) are made only in that case.
    
    覆盖:
    
    isValidEnter 在类中 XMLElement
    
    参数:
    
    p - The panel for editing parameters.
    
    返回:
    
    If this is an activity which type is not SubFlow, always returns true, and f this is a SubFlow type activity, returns true if actual and formal parameter types and number are matching, false otherwise. 活动节点数据合法性判断
  - setCollection
```
protected void setCollection(Activities newCollection)
```
    Used to set the collection that activity belongs to. The activity can change its collection when it is beeing copied from the process to the block or vice-versa.
  - setPosition
```
public void setPosition(String position)
```
  - getProperty
```
public Object getProperty(String key)
```
  - setProperty
```
public void setProperty(String key,
                        Object obj)
```
  - refreshPlugins
```
public void refreshPlugins()
```
  - clonePlugins
```
public Activity clonePlugins(Activity act)
```
  - setWorkflowProcess
```
public void setWorkflowProcess(WorkflowProcess wp)
```
  - getNonExceptionalOutgoingTransitions
```
public Set getNonExceptionalOutgoingTransitions()
```
  - getIncomingTransitions
```
public Set getIncomingTransitions()
```
  - getAttrName
```
public XMLAttribute getAttrName()
```
  - setAttrName
```
public void setAttrName(XMLAttribute attrName)
```

类 Activity

字段概要

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

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

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

构造器概要

方法概要

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

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

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

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

构造器详细资料

Activity

方法详细资料

getOwnerProcess

getActivityEvent

setActivityEvent

fromXML

afterImporting

afterImporting

getStartDescriptions

setStartDescriptions

getEndDescriptions

setEndDescriptions

getVisuallySortedParticipantIDs

setVisuallySortedParticipantIDs

getXOffset

setXOffset

getYOffset

setYOffset

getParticipantID

setParticipantID

setOutgoingTransitions

getType

setJoinType

getJoin

setSplitType

getSplit

getTools

getSubflow

getOutflow

getServices

getDevices

getEvents

getBlockActivity

fillStructure

getPanel

fillOutgoingTransitions

addUserProperty

removeUserProperty

refreshMandatories

toString

getTooltip

toXML

setReadOnly

clone

refreshLabelName

isIDUniqueAndValid

isValidEnter

setCollection

setPosition

getProperty

setProperty

refreshPlugins

clonePlugins

setWorkflowProcess

getNonExceptionalOutgoingTransitions

getIncomingTransitions

getAttrName

setAttrName