|
|||||||||||
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
wt.workflow.robots.WfRobotActivity
wt.workflow.robots.WfSynchRobot
Robot used to synchronize with with external (non-workflow) events. There are three kinds of synch robots:
In the EVENT and OBJECT_EVENT cases it is possible to create an expression to filter the event. In all cases, the extrenal event must be translated into a internal workflow event that is then used for routing purposes.
Use the newWfSynchRobot
static factory method(s), not the
WfSynchRobot
constructor, to construct instances of this
class. Instances must be constructed using the static factory(s), in
order to ensure proper initialization of the instance.
Supported API: false
Extendable: false
Field Summary | |
private static String |
CLASSNAME
|
static String |
EVENT_KEY
Label for the attribute. |
private static int |
EVENT_KEY_UPPER_LIMIT
|
private String |
eventKey
|
static long |
EXTERNALIZATION_VERSION_UID
|
protected static long |
OLD_FORMAT_VERSION_UID
|
private static String |
RESOURCE
|
(package private) static long |
serialVersionUID
|
static String |
SYNCH_EXPR
Label for the attribute. |
static String |
SYNCH_TYPE
Label for the attribute; Type of the synchronization. |
private static int |
SYNCH_TYPE_UPPER_LIMIT
|
private WfExpression |
synchExpr
|
private WfSynchType |
synchType
|
static String |
TARGET_CLASS_NAME
Label for the attribute. |
private static int |
TARGET_CLASS_NAME_UPPER_LIMIT
|
static String |
TARGET_VARIABLE_NAME
Label for the attribute; Attribute that holds name of the variable that references the object to be used for object event synchronization. |
private static int |
TARGET_VARIABLE_NAME_UPPER_LIMIT
|
private String |
targetClassName
|
private String |
targetVariableName
|
private static boolean |
VERBOSE
|
Fields inherited from class wt.workflow.engine.WfActivity |
INPUT_VARIABLE_MAP, OUTPUT_VARIABLE_MAP, ROUTER_TYPE, TRIP_COUNT, USER_EVENT_LIST |
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 | |
WfSynchRobot()
|
Method Summary | |
void |
checkInitialCondition(ObjectIdentifier target_id,
String event_key)
Evaluates initial synchronization expression for the object event robot. |
void |
checkInitialCondition(String event_key)
Evaluates initial synchronization expression for the class event robot. |
void |
deleteSubscriptions()
Deletes all object subscriptions associated with the robot. |
protected void |
doAbortTransition()
Unsubscribes to robot's event if previous state was OPEN_RUNNING. |
protected void |
doCompleteTransition()
Unsubscribes to robot's event. |
protected void |
doResetTransition()
Unsubscribes to robot's event if previous state was OPEN_RUNNING. |
protected void |
doResumeTransition()
Subscribes to robot's event. |
protected void |
doSuspendTransition()
Unsubscribes to robot's event. |
protected void |
doTerminateTransition()
Unsubscribes to robot's event if previous state was OPEN_RUNNING. |
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 |
evaluateSynchExpression(KeyedEvent event)
Evaluates synchronization expression given a keyed event. |
Object |
evaluateSynchExpression(ObjectIdentifier target_id,
String event_key)
Evaluates synchronization expression given a target object identifier and a event key. |
private void |
eventKeyValidate(String a_EventKey)
|
String |
getConceptualClassname()
Deprecated. |
ProcessData |
getContext()
Returns the parent process' variables. |
String |
getEventKey()
Gets the value of the attribute: EVENT_KEY. |
private ObjectIdentifier |
getId(Object object)
Helper method that extracts object identifier. |
WfExpression |
getSynchExpr()
Gets the value of the attribute: SYNCH_EXPR. |
WfSynchType |
getSynchType()
Gets the value of the attribute: SYNCH_TYPE. |
String |
getTargetClassName()
Gets the value of the attribute: TARGET_CLASS_NAME. |
String |
getTargetVariableName()
Gets the value of the attribute: TARGET_VARIABLE_NAME. |
private Object[] |
getValues(WfProcess process)
Extracts values from process. |
int |
hashCode()
Returns a hash code for this object based upon its ObjectIdentifier . |
protected void |
initialize(WfContainer container)
Initializes the router type to conditional, as synch robots map external events into local ones. |
static WfSynchRobot |
newWfSynchRobot(WfContainer container)
Constructs a synchronization robot in a given container (process or block). |
void |
notifyObjectEvent(ObjectIdentifier target_id,
String event_key)
This method is called whenever the event subscribed to occurs to the object target of the subscriptions. |
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(WfSynchRobot thisObject,
ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source. |
void |
resetValues()
Does nothing. |
void |
run()
Executes robot activity. |
void |
setEventKey(String a_EventKey)
Sets the value of the attribute: EVENT_KEY. |
void |
setSynchExpr(WfExpression a_SynchExpr)
Sets the value of the attribute: SYNCH_EXPR. |
void |
setSynchType(WfSynchType a_SynchType)
Sets the value of the attribute: SYNCH_TYPE. |
void |
setTargetClassName(String a_TargetClassName)
Sets the value of the attribute: TARGET_CLASS_NAME. |
void |
setTargetVariableName(String a_TargetVariableName)
Sets the value of the attribute: TARGET_VARIABLE_NAME. |
protected void |
subscribeToClassEvent()
Supported API: false |
protected void |
subscribeToObjectEvent()
Supported API: false |
private void |
targetClassNameValidate(String a_TargetClassName)
|
private void |
targetVariableNameValidate(String a_TargetVariableName)
|
String |
toString()
Returns a string representation of the execution object. |
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.robots.WfRobotActivity |
changeState, readVersion |
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 |
Field Detail |
private static final String RESOURCE
private static final String CLASSNAME
public static final String TARGET_CLASS_NAME
private static int TARGET_CLASS_NAME_UPPER_LIMIT
private String targetClassName
public static final String TARGET_VARIABLE_NAME
private static int TARGET_VARIABLE_NAME_UPPER_LIMIT
private String targetVariableName
public static final String SYNCH_EXPR
private transient WfExpression synchExpr
public static final String EVENT_KEY
private static int EVENT_KEY_UPPER_LIMIT
private String eventKey
public static final String SYNCH_TYPE
private static int SYNCH_TYPE_UPPER_LIMIT
private WfSynchType synchType
static final long serialVersionUID
public static final long EXTERNALIZATION_VERSION_UID
protected static final long OLD_FORMAT_VERSION_UID
private static final boolean VERBOSE
Constructor Detail |
public WfSynchRobot()
Method Detail |
public void writeExternal(ObjectOutput output) throws IOException
writeExternal
in interface Externalizable
writeExternal
in class WfRobotActivity
output
-
IOException
public void readExternal(ObjectInput input) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
readExternal
in class WfRobotActivity
input
-
IOException
ClassNotFoundException
protected boolean readVersion(WfSynchRobot 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 WfRobotActivity
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 WfRobotActivity
input
-
SQLException
DatastoreException
public String getConceptualClassname()
getConceptualClassname
in interface NetFactor
public String getTargetClassName()
public void setTargetClassName(String a_TargetClassName) throws WTPropertyVetoException
a_TargetClassName
-
WTPropertyVetoException
private void targetClassNameValidate(String a_TargetClassName) throws WTPropertyVetoException
a_TargetClassName
-
WTPropertyVetoException
public String getTargetVariableName()
public void setTargetVariableName(String a_TargetVariableName) throws WTPropertyVetoException
a_TargetVariableName
-
WTPropertyVetoException
private void targetVariableNameValidate(String a_TargetVariableName) throws WTPropertyVetoException
a_TargetVariableName
-
WTPropertyVetoException
public WfExpression getSynchExpr()
public void setSynchExpr(WfExpression a_SynchExpr) throws WTPropertyVetoException
a_SynchExpr
-
WTPropertyVetoException
public String getEventKey()
public void setEventKey(String a_EventKey) throws WTPropertyVetoException
a_EventKey
-
WTPropertyVetoException
private void eventKeyValidate(String a_EventKey) throws WTPropertyVetoException
a_EventKey
-
WTPropertyVetoException
public WfSynchType getSynchType()
public void setSynchType(WfSynchType a_SynchType) throws WTPropertyVetoException
a_SynchType
-
WTPropertyVetoException
public String toString()
toString
in class WfRobotActivity
public static WfSynchRobot newWfSynchRobot(WfContainer container) throws WTException
container
-
WTException
public void run() throws WTException
run
in class WfRobotActivity
WTException
protected void doCompleteTransition() throws WTException
doCompleteTransition
in class WfActivity
WTException
protected void doSuspendTransition() throws WTException
doSuspendTransition
in class WfActivity
WTException
protected void doResumeTransition() throws WTException
doResumeTransition
in class WfActivity
WTException
protected void doTerminateTransition() throws WTException
doTerminateTransition
in class WfActivity
WTException
protected void doAbortTransition() throws WTException
doAbortTransition
in class WfActivity
WTException
protected void doResetTransition() throws WTException
doResetTransition
in class WfActivity
WTException
public Object evaluateSynchExpression(KeyedEvent event) throws WTException
event
-
WTException
public Object evaluateSynchExpression(ObjectIdentifier target_id, String event_key) throws WTException
target_id
- event_key
-
WTException
public void checkInitialCondition(String event_key) throws WTException
event_key
-
WTException
public void checkInitialCondition(ObjectIdentifier target_id, String event_key) throws WTException
target_id
- event_key
-
WTException
public ProcessData getContext()
getContext
in class WfExecutionObject
public void resetValues() throws WTException
resetValues
in class WfExecutionObject
WTException
public void notifyObjectEvent(ObjectIdentifier target_id, String event_key) throws WTException
notifyObjectEvent
in interface ObjectSubscriptionListener
target_id
- event_key
-
WTException
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 WfRobotActivity
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 WfRobotActivity
protected void initialize(WfContainer container) throws WTException
initialize
in class WfActivity
container
-
WTException
protected void subscribeToObjectEvent() throws WTException
WTException
protected void subscribeToClassEvent() throws WTException
WTException
public void deleteSubscriptions() throws WTException
WTException
private Object[] getValues(WfProcess process)
private ObjectIdentifier getId(Object object)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |