|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.fc.WTObject
wt.enterprise.Simple
wt.workflow.engine.WfExecutionObject
wt.workflow.engine.WfActivity
WfActivity
represents a request for work in the context
of the containing WfProcess. There can be many active WfActivity objects
within a WfProcess at a given point in time. The lifetime of the activity
is limited by that of its containing process.
The context of an activity is set by the containing process before the activity is activated depending on the variable map that relates local activity variables with global (process) variables.
A given variable may be used in many ways, as follows:
An activity may or not contain routing functionality. This is indicated
by the router type of the activity that can be NONE (no routing functionality),
CONDITIONAL (conditional or automatic routing) and MANUAL (manual routing).
If an activity has routing functionality, then after it completes, a
routing event is generated either by evaluating a "routing expression"
or by getting input from the user about the routing event. The event
information is used by outgoing links to for transfer of control decisions.
Supported API: false
Extendable: false
Field Summary | |
private static boolean |
ABORT_PROCESS_ON_ABORT
|
private static String |
CLASSNAME
|
static long |
EXTERNALIZATION_VERSION_UID
|
static String |
INPUT_VARIABLE_MAP
Label for the attribute; Input map from process to activity variables. |
private static int |
INPUT_VARIABLE_MAP_UPPER_LIMIT
|
private WfVariableMap |
inputVariableMap
|
protected static long |
OLD_FORMAT_VERSION_UID
|
static String |
OUTPUT_VARIABLE_MAP
Label for the attribute; Output map from activity to process variables. |
private static int |
OUTPUT_VARIABLE_MAP_UPPER_LIMIT
|
private WfVariableMap |
outputVariableMap
|
private WfContainerReference |
parentProcessRef
|
private static String |
RESOURCE
|
static String |
ROUTER_TYPE
Label for the attribute; This attribute tells whether the router is a conditional router, a manual router or none. |
private static int |
ROUTER_TYPE_UPPER_LIMIT
|
private WfRouterType |
routerType
|
(package private) static long |
serialVersionUID
|
static String |
TRIP_COUNT
Label for the attribute. |
private int |
tripCount
|
static String |
USER_EVENT_LIST
Label for the attribute; List of the user defined events. |
private static int |
USER_EVENT_LIST_UPPER_LIMIT
|
private UserEventVector |
userEventList
|
private static boolean |
VERBOSE
|
Fields inherited from class wt.workflow.engine.WfExecutionObject |
AD_SQEN, ALERT_TIME, CHANGE_STATE_TIME, CONTAINER, CONTEXT, D_SQEN, DEADLINE, DEADLINE_DURATION, DESCRIPTION, END_TIME, EVENT_CONFIGURATION, EXCEPTION_MESSAGE, KEY, NAME, PD_SQEN, PRIORITY, START_TIME, STATE, SUSPEND_TIME, TEMPLATE, TIME_PAST_DEADLINE, TIME_TO_DEADLINE, TIME_TO_START |
Fields inherited from class wt.enterprise.Simple |
|
Fields inherited from class wt.fc.WTObject |
CREATE_TIMESTAMP, MODIFY_TIMESTAMP |
Fields inherited from interface wt.workflow.engine.WfNode |
PARENT_PROCESS_REF |
Fields inherited from interface wt.inf.container.WTContained |
CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE |
Fields inherited from interface wt.fc.Persistable |
IDENTITY, PERSIST_INFO, TYPE |
Fields inherited from interface wt.admin.DomainAdministered |
DOMAIN_REF, INHERITED_DOMAIN |
Fields inherited from interface wt.fc.BusinessInformation |
BUSINESS_TYPE, IDENTITY |
Fields inherited from interface wt.notify.Notifiable |
EVENT_SET |
Fields inherited from interface wt.identity.DisplayIdentification |
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE |
Constructor Summary | |
WfActivity()
|
Method Summary | |
WfExecutionObject |
changeState(WfTransition transition)
Updates the current state of the activity. |
WfExecutionObject |
changeState(WfTransition transition,
boolean propagate)
Updates the current state of the activity. |
protected WfExecutionObject |
changeState(WfTransition transition,
boolean is_immediate,
boolean propagate)
Protected method that does the actual state change work. |
protected void |
checkSuspendedProcess()
Checks if the process is suspended. |
WfActivity |
complete(Vector selected_events)
Completes activity and generates events. |
protected void |
computeDeadline(long now)
Computes deadline using both the duration and the duration counted from the host process start. |
Timestamp |
computeDeadline(long now,
long duration,
long process_duration)
|
protected Timestamp |
computeTimeToStart(long now)
Computes time to start activity. |
void |
deleteActivity()
Delete myself. |
protected void |
doAbortTransition()
Performs specific tasks associated with the START transition. |
protected void |
doCompleteTransition()
Performs specific tasks associated with the COMPLETE transition. |
protected void |
doDisableTransition()
Performs specific tasks associated with the DISABLE transition. |
protected void |
doEnableTransition()
Performs specific tasks associated with the ENABLE transition. |
protected void |
doResetTransition()
Supported API: false |
protected void |
doResumeTransition()
Performs specific tasks associated with the RESUME transition. |
protected void |
doSkipTransition()
Performs specific tasks associated with the SKIP transition. |
protected void |
doStartTransition()
Performs specific tasks associated with the START transition. |
protected void |
doSuspendTransition()
Performs specific tasks associated with the SUSPEND transition. |
protected void |
doTerminateTransition()
Performs specific tasks associated with the START transition. |
protected void |
doWork(WfTransition transition)
Internal method used to cause the performance of the work associated with the transition passed as argument. |
boolean |
equals(Object obj)
Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifier s. |
Object |
evaluateRouterExpression()
Evaluates expression associated with the router. |
WfVariableMap |
getInputVariableMap()
Gets the value of the attribute: INPUT_VARIABLE_MAP. |
WfVariableMap |
getOutputVariableMap()
Gets the value of the attribute: OUTPUT_VARIABLE_MAP. |
WfProcess |
getParentProcess()
If the activity is contained in a process, this is returned; otherwise returns the innermost process that contains the block that is the activity's parent container. |
WfProcess |
getParentProcessReadOnly()
|
WfContainerReference |
getParentProcessRef()
Gets the value of the attribute: PARENT_PROCESS_REF. |
Object |
getRouterEvent()
Gets user routing event. |
WfRouterType |
getRouterType()
Gets the value of the attribute: ROUTER_TYPE. |
private WTPrincipal |
getSystemCalendarOwner()
|
ObjectReference |
getTemplateReference()
Returns a reference to template used to instantiate current activity. |
int |
getTripCount()
Gets the value of the attribute: TRIP_COUNT. |
UserEventVector |
getUserEventList()
Gets the value of the attribute: USER_EVENT_LIST. |
protected WfException |
getWfException(WTException wte,
WfTransition transition)
Returns an exception appropriate to the transition. |
int |
hashCode()
Returns a hash code for this object based upon its ObjectIdentifier . |
protected boolean |
hasRouterExpression()
|
protected void |
initialize(WfContainer container)
Supported API: false |
protected void |
propagateEvent(Object event)
Propagate event to successor nodes. |
void |
readExternal(ObjectInput input)
Reads the non-transient fields of this class from an external source. |
void |
readExternal(PersistentRetrieveIfc input)
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store. |
private boolean |
readOldVersion(ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source, which is not the current version. |
void |
readValues()
Reads values from the containing process. |
protected boolean |
readVersion(WfActivity thisObject,
ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source. |
protected void |
registerEvent(Object event,
WfState old_state)
Register event with engine service. |
void |
setInputVariableMap(WfVariableMap a_InputVariableMap)
Sets the value of the attribute: INPUT_VARIABLE_MAP. |
void |
setOutputVariableMap(WfVariableMap a_OutputVariableMap)
Sets the value of the attribute: OUTPUT_VARIABLE_MAP. |
void |
setParentProcessRef(WfContainerReference a_ParentProcessRef)
Sets the value of the attribute: PARENT_PROCESS_REF. |
void |
setRouterType(WfRouterType a_RouterType)
Sets the value of the attribute: ROUTER_TYPE. |
void |
setTripCount(int a_TripCount)
Sets the value of the attribute: TRIP_COUNT. |
void |
setUserEventList(UserEventVector a_UserEventList)
Sets the value of the attribute: USER_EVENT_LIST. |
String |
toString()
Returns a string representation of the activity. |
boolean |
updateWfAssigneeNotification()
|
long |
updateWfDueDate()
|
long |
updateWfDuration()
|
void |
writeExternal(ObjectOutput output)
Writes the non-transient fields of this class to an external source. |
void |
writeExternal(PersistentStoreIfc output)
Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store. |
void |
writeValues()
Writes values to the containing process. |
Methods inherited from class wt.enterprise.Simple |
getBusinessType, getDomainRef, getEventSet, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain |
Methods inherited from class wt.fc.WTObject |
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo |
Methods inherited from class java.lang.Object |
clone, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface wt.fc.Persistable |
checkAttributes, getPersistInfo, getType, setPersistInfo |
Methods inherited from interface wt.fc.NetFactor |
getClassInfo, getConceptualClassname |
Field Detail |
private static final String RESOURCE
private static final String CLASSNAME
public static final String ROUTER_TYPE
private static int ROUTER_TYPE_UPPER_LIMIT
private WfRouterType routerType
public static final String USER_EVENT_LIST
private static int USER_EVENT_LIST_UPPER_LIMIT
private UserEventVector userEventList
public static final String INPUT_VARIABLE_MAP
private static int INPUT_VARIABLE_MAP_UPPER_LIMIT
private WfVariableMap inputVariableMap
public static final String OUTPUT_VARIABLE_MAP
private static int OUTPUT_VARIABLE_MAP_UPPER_LIMIT
private WfVariableMap outputVariableMap
public static final String TRIP_COUNT
private int tripCount
private WfContainerReference parentProcessRef
static final long serialVersionUID
public static final long EXTERNALIZATION_VERSION_UID
protected static final long OLD_FORMAT_VERSION_UID
private static final boolean VERBOSE
private static final boolean ABORT_PROCESS_ON_ABORT
Constructor Detail |
public WfActivity()
Method Detail |
public void writeExternal(ObjectOutput output) throws IOException
writeExternal
in interface Externalizable
writeExternal
in class WfExecutionObject
output
-
IOException
public void readExternal(ObjectInput input) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
readExternal
in class WfExecutionObject
input
-
IOException
ClassNotFoundException
protected boolean readVersion(WfActivity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
thisObject
- input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
private boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
public void writeExternal(PersistentStoreIfc output) throws SQLException, DatastoreException
(Not intended for general use.)
Supported API: false
writeExternal
in interface ObjectMappable
writeExternal
in class WfExecutionObject
output
-
SQLException
DatastoreException
public void readExternal(PersistentRetrieveIfc input) throws SQLException, DatastoreException
(Not intended for general
use.)
Supported API: false
readExternal
in interface ObjectMappable
readExternal
in class WfExecutionObject
input
-
SQLException
DatastoreException
public WfRouterType getRouterType()
public void setRouterType(WfRouterType a_RouterType)
a_RouterType
- public UserEventVector getUserEventList()
public void setUserEventList(UserEventVector a_UserEventList)
a_UserEventList
- public WfVariableMap getInputVariableMap()
public void setInputVariableMap(WfVariableMap a_InputVariableMap)
a_InputVariableMap
- public WfVariableMap getOutputVariableMap()
public void setOutputVariableMap(WfVariableMap a_OutputVariableMap)
a_OutputVariableMap
- public int getTripCount()
public void setTripCount(int a_TripCount) throws WTPropertyVetoException
a_TripCount
-
WTPropertyVetoException
public WfExecutionObject changeState(WfTransition transition) throws WTException
changeState
in class WfExecutionObject
transition
-
WTException
public WfExecutionObject changeState(WfTransition transition, boolean propagate) throws WTException
transition
- propagate
-
WTException
public String toString()
toString
in class WfExecutionObject
public Object evaluateRouterExpression() throws WTException
WTException
public Object getRouterEvent() throws WTException
WTException
public void readValues() throws WTException
WTException
public void writeValues() throws WTException
WTException
public ObjectReference getTemplateReference()
getTemplateReference
in interface WfNode
protected void doStartTransition() throws WTException
WTException
protected void doCompleteTransition() throws WTException
WTException
protected void doSuspendTransition() throws WTException
WTException
protected void doResumeTransition() throws WTException
WTException
protected void doDisableTransition() throws WTException
WTException
protected void doEnableTransition() throws WTException
WTException
protected void doSkipTransition() throws WTException
WTException
protected void doTerminateTransition() throws WTException
WTException
protected void doAbortTransition() throws WTException
WTException
protected void doResetTransition() throws WTException
WTException
public WfActivity complete(Vector selected_events) throws WTException
selected_events
-
WTException
protected void doWork(WfTransition transition) throws WTException
transition
-
WTException
protected Timestamp computeTimeToStart(long now) throws WTException
now
-
WTException
protected void computeDeadline(long now) throws WTException
computeDeadline
in class WfExecutionObject
now
-
WTException
protected void initialize(WfContainer container) throws WTException
container
-
WTException
public WfProcess getParentProcess() throws WTException
WTException
protected WfExecutionObject changeState(WfTransition transition, boolean is_immediate, boolean propagate) throws WTException
transition
- is_immediate
- propagate
-
WTException
public WfContainerReference getParentProcessRef()
getParentProcessRef
in interface WfNode
public void setParentProcessRef(WfContainerReference a_ParentProcessRef)
setParentProcessRef
in interface WfNode
a_ParentProcessRef
- public boolean equals(Object obj)
ObjectIdentifier
s.
Changed or stale copies are still considered equal by this method.
Delegates to PersistenceHelper.equals(Persistable,Object)
.
Warning: Certain core Windchill operations may depend upon
equals
being ObjectIdentifier
-based. Changes
to the default implementation should be done with care, if at all.
Supported API: false
equals
in class WfExecutionObject
obj
-
public int hashCode()
ObjectIdentifier
.
Delegates to PersistenceHelper.hashCode(Persistable)
.
Warning: Certain core Windchill operations may depend upon
hashCode
being ObjectIdentifier-based
. Changes
to the default implementation should be done with care, if at all.
Supported API: false
hashCode
in class WfExecutionObject
protected WfException getWfException(WTException wte, WfTransition transition)
protected void propagateEvent(Object event) throws WTException
WTException
protected void registerEvent(Object event, WfState old_state) throws WTException
WTException
protected void checkSuspendedProcess() throws WTException
WTException
public void deleteActivity() throws WTException
WTException
protected boolean hasRouterExpression() throws WTException
WTException
public Timestamp computeDeadline(long now, long duration, long process_duration) throws WTException
WTException
private WTPrincipal getSystemCalendarOwner() throws WTException
WTException
public WfProcess getParentProcessReadOnly() throws WTException
WTException
public long updateWfDueDate() throws WTException
WTException
public long updateWfDuration() throws WTException
WTException
public boolean updateWfAssigneeNotification() throws WTException
WTException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |