wt.workflow.engine
Class WfContainer

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.engine.WfExecutionObject
              wt.workflow.engine.WfContainer

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

Direct Known Subclasses:

WfBlock, WfProcess

public abstract class WfContainer

extends WfExecutionObject

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	REQUESTER_REF Label for the attribute; Reference to associated requester.
private ObjectReference	requesterRef
private static String	RESOURCE
(package private) static long	serialVersionUID
private static boolean	VERBOSE
private static String	WF_CONNECTOR_CLASS_NAME

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.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

WfContainer()

Method Summary

protected void	abortContainedActivities() Aborts all contained activities that are in the OPEN state.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
QueryResult	getContainerNodes()
WTPrincipalReference	getCreator() Returns container creator in case it is a process or host process' cretaor in case it is a block.
private ObjectIdentifier	getId(Object obj)
abstract ObjectReference	getProjectRef() Returns a reference to the project used to resolve roles.
WfRequester	getRequester() Returns the WfProcessRequester associated with the process.
ObjectReference	getRequesterRef() Gets the value of the attribute: REQUESTER_REF.
protected WfConnector	getStartConnector() Returns the start connector associated with process.
abstract TeamReference	getTeamId() Returns a reference to the team used to resolve roles.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
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.
protected boolean	readVersion(WfContainer thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	resetContainedActivities() Resets all contained activities.
protected void	resumeContainedActivities() Resumes all contained activities that are in the INTERMITTED state.
protected void	sendEventToRequester(Object event) Propagate event to requester if there is one.
void	setRequesterRef(ObjectReference a_RequesterRef) Sets the value of the attribute: REQUESTER_REF.
protected void	suspendContainedActivities() Suspends all contained activities that are in the RUNNING state.
protected void	terminateContainedActivities() Terminates all contained activities that are in the OPEN state.
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.

Methods inherited from class wt.workflow.engine.WfExecutionObject

calculateTimePastDeadline, calculateTimeToDeadline, changeDeadline, changeState, changeStateAttributes, computeDeadline, computeTimePastDeadline, computeTimeToDeadline, evaluateExpression, getAdSQEN, getAlertTime, getChangeStateTime, getContainer, getContainerName, getContainerReference, getContext, getDeadline, getDeadlineDuration, getDescription, getDSQEN, getEndTime, getEventConfiguration, getIdentity, getKey, getName, getPdSQEN, getPriority, getStartTime, getState, getSuspendTime, getTemplate, getTimePastDeadline, getTimeToDeadline, getTimeToStart, getVarDueDate, getVarDuration, getVarNotification, initialize, initialize, isOverdue, readVersion, removeDeadlineQueueEntries, resetValues, setAdSQEN, setAlertTime, setChangeStateTime, setContainer, setContainerReference, setContext, setDeadline, setDeadlineDuration, setDescription, setDSQEN, setEndTime, setEventConfiguration, setKey, setName, setPdSQEN, setPriority, setStartTime, setState, setSuspendTime, setTemplate, setTimePastDeadline, setTimeToDeadline, setTimeToStart, toString, validTransitions

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

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

REQUESTER_REF

public static final String REQUESTER_REF

Label for the attribute; Reference to associated requester. May be null if process is not embedded in another process or external application.

Supported API: false

See Also:

Constant Field Values

requesterRef

private ObjectReference requesterRef

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

WF_CONNECTOR_CLASS_NAME

private static final String WF_CONNECTOR_CLASS_NAME

Constructor Detail

WfContainer

public WfContainer()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class WfExecutionObject

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class WfExecutionObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfContainer thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

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.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class WfExecutionObject

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class WfExecutionObject

Parameters:

input -

Throws:

SQLException

DatastoreException

getRequesterRef

public ObjectReference getRequesterRef()

Gets the value of the attribute: REQUESTER_REF. Reference to associated requester. May be null if process is not embedded in another process or external application.

Supported API: false

Returns:

ObjectReference

setRequesterRef

public void setRequesterRef(ObjectReference a_RequesterRef)

Sets the value of the attribute: REQUESTER_REF. Reference to associated requester. May be null if process is not embedded in another process or external application.

Supported API: false

Parameters:

a_RequesterRef -

getStartConnector

protected WfConnector getStartConnector()
                                 throws WTException

Returns the start connector associated with process.

Supported API: false

Returns:

WfConnector

Throws:

WTException

getRequester

public WfRequester getRequester()

Returns the WfProcessRequester associated with the process. May return null if there is no associated requester.

Supported API: false

Returns:

WfRequester

terminateContainedActivities

protected void terminateContainedActivities()
                                     throws WTException

Terminates all contained activities that are in the OPEN state.

Supported API: false

Throws:

WTException

suspendContainedActivities

protected void suspendContainedActivities()
                                   throws WTException

Suspends all contained activities that are in the RUNNING state.

Supported API: false

Throws:

WTException

resumeContainedActivities

protected void resumeContainedActivities()
                                  throws WTException

Resumes all contained activities that are in the INTERMITTED state.

Supported API: false

Throws:

WTException

abortContainedActivities

protected void abortContainedActivities()
                                 throws WTException

Aborts all contained activities that are in the OPEN state.

Supported API: false

Throws:

WTException

resetContainedActivities

protected void resetContainedActivities()
                                 throws WTException

Resets all contained activities. That is, force all contained activities to go to the OPEN_NOT_RUNNING_NOT_STARTED state.

Supported API: false

Throws:

WTException

sendEventToRequester

protected void sendEventToRequester(Object event)
                             throws WTException

Propagate event to requester if there is one. Do nothing othewrwise.

Supported API: false

Parameters:

event -

Throws:

WTException

getCreator

public WTPrincipalReference getCreator()

Returns container creator in case it is a process or host process' cretaor in case it is a block.

Supported API: false

Returns:

WTPrincipalReference

getProjectRef

public abstract ObjectReference getProjectRef()

Returns a reference to the project used to resolve roles.

Supported API: false

Returns:

ObjectReference

getTeamId

public abstract TeamReference getTeamId()

Returns a reference to the team used to resolve roles.

Supported API: false

Returns:

TeamReference

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. 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

Overrides:

equals in class WfExecutionObject

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its 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

Overrides:

hashCode in class WfExecutionObject

Returns:

int

getId

private ObjectIdentifier getId(Object obj)

getContainerNodes

public QueryResult getContainerNodes()
                              throws WTException

Throws:

WTException