|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.fc.WTObject
wt.workflow.engine.WfConnector
The WfConnector
class represents logical sequencing combinations
between workflow steps. A connector is a valid workflow node (WfNode)
and may be the source and destinations of many workflow links. The links
for which the connector is source are called "outgoing" links; those
for which it is destination are called "incoming" links.
There are four types of connectors:
Note: XOR is not implemented and is listed for completeness.
The same way as activities, connectors can also present routing conditioinal (automatic) functionality. In this case, when a connector fires, an event is generated by evaluating a 'router' expression. In this expression the variables used are those of the containing process.
Use the newWfConnector
static factory method(s), not the
WfConnector
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 |
CONNECTOR_FUNCTION
Label for the attribute; Function of the connector. |
private static int |
CONNECTOR_FUNCTION_UPPER_LIMIT
|
static String |
CONNECTOR_TYPE
Label for the attribute; Type of the connector. |
private static int |
CONNECTOR_TYPE_UPPER_LIMIT
|
private WfConnectorFunction |
connectorFunction
|
private WfConnectorType |
connectorType
|
static long |
EXTERNALIZATION_VERSION_UID
|
private static int |
FIRED_LINK_LIST_UPPER_LIMIT
|
private FiredLinkVector |
firedLinkList
|
static String |
FIRING_THRESHOLD
Label for the attribute; Number of fired incoming links necessary for the connector to fire outgoing links. |
private int |
firingThreshold
|
static String |
NUMBER_FIRED_PREDECESSORS
Label for the attribute; Number of predecessor links that has fired. |
static String |
NUMBER_PREDECESSORS
Label for the attribute; Total number of predecessor links. |
private int |
numberFiredPredecessors
|
private int |
numberPredecessors
|
protected static long |
OLD_FORMAT_VERSION_UID
|
private WfContainerReference |
parentProcessRef
|
private static String |
RESOURCE
|
static String |
ROUTER_TYPE
Label for the attribute; Whether the connector is a routing connector. |
private static int |
ROUTER_TYPE_UPPER_LIMIT
|
private WfRouterType |
routerType
|
(package private) static long |
serialVersionUID
|
private WfConnectorState |
state
|
static String |
STATE
Label for the attribute; State of the connector: one of {ENABLED, DISABLED}. |
private static int |
STATE_UPPER_LIMIT
|
private WfNodeTemplateReference |
template
|
static String |
TEMPLATE
Label for the attribute; Reference to the template used to create connector. |
static String |
TERMINATE_ACTIVITIES
Label for the attribute. |
private boolean |
terminateActivities
|
static String |
USER_EVENT_LIST
Label for the attribute; List of events associated with the connector for routing connectors. |
private static int |
USER_EVENT_LIST_UPPER_LIMIT
|
private UserEventVector |
userEventList
|
private static boolean |
VERBOSE
|
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.fc.Persistable |
IDENTITY, PERSIST_INFO, TYPE |
Fields inherited from interface wt.identity.DisplayIdentification |
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE |
Constructor Summary | |
WfConnector()
|
Method Summary | |
protected WfConnector |
addOneToThreshold()
Adds one to firing threshold for THRESHOLD connectors. |
WfConnector |
changeState(WfConnectorAction action)
Changes the connector's state. |
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. |
void |
fire()
Unconditionally fires connector. |
protected void |
fire(boolean is_immediate)
Unconditional firing. |
void |
fireInput(ObjectReference link_ref)
Method called by afferent links (or parent process) to indicate that the link is activated. |
String |
getConceptualClassname()
Deprecated. |
WfConnectorFunction |
getConnectorFunction()
Gets the value of the attribute: CONNECTOR_FUNCTION. |
WfConnectorType |
getConnectorType()
Gets the value of the attribute: CONNECTOR_TYPE. |
int |
getFiringThreshold()
Gets the value of the attribute: FIRING_THRESHOLD. |
int |
getNumberFiredPredecessors()
Gets the value of the attribute: NUMBER_FIRED_PREDECESSORS. |
int |
getNumberPredecessors()
Gets the value of the attribute: NUMBER_PREDECESSORS. |
WfContainerReference |
getParentProcessRef()
Gets the value of the attribute: PARENT_PROCESS_REF. |
WfRouterType |
getRouterType()
Gets the value of the attribute: ROUTER_TYPE. |
WfConnectorState |
getState()
Gets the value of the attribute: STATE. |
WfNodeTemplateReference |
getTemplate()
Gets the value of the attribute: TEMPLATE. |
ObjectReference |
getTemplateReference()
Returns reference to template. |
UserEventVector |
getUserEventList()
Gets the value of the attribute: USER_EVENT_LIST. |
int |
hashCode()
Returns a hash code for this object based upon its ObjectIdentifier . |
protected void |
initialize(WfContainer container,
WfConnectorFunction function,
WfConnectorType type)
Supports initialization, following construction of an instance. |
boolean |
isTerminateActivities()
Gets the value of the attribute: TERMINATE_ACTIVITIES. |
static WfConnector |
newWfConnector(WfContainer container,
WfConnectorFunction function,
WfConnectorType type)
Connector's constructor. |
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. |
protected boolean |
readVersion(WfConnector thisObject,
ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source. |
protected void |
setConnectorFunction(WfConnectorFunction a_ConnectorFunction)
Sets the value of the attribute: CONNECTOR_FUNCTION. |
protected void |
setConnectorType(WfConnectorType a_ConnectorType)
Sets the value of the attribute: CONNECTOR_TYPE. |
void |
setFiringThreshold(int a_FiringThreshold)
Sets the value of the attribute: FIRING_THRESHOLD. |
protected void |
setNumberFiredPredecessors(int a_NumberFiredPredecessors)
Sets the value of the attribute: NUMBER_FIRED_PREDECESSORS. |
void |
setNumberPredecessors(int a_NumberPredecessors)
Sets the value of the attribute: NUMBER_PREDECESSORS. |
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. |
protected void |
setState(WfConnectorState a_State)
Sets the value of the attribute: STATE. |
void |
setTemplate(WfNodeTemplateReference a_Template)
Sets the value of the attribute: TEMPLATE. |
void |
setTerminateActivities(boolean a_TerminateActivities)
Sets the value of the attribute: TERMINATE_ACTIVITIES. |
void |
setUserEventList(UserEventVector a_UserEventList)
Sets the value of the attribute: USER_EVENT_LIST. |
protected WfConnector |
subtractOneFromThreshold()
Subtracts one from firing threshold for THRESHOLD connectors if firing threshold is greater than zero; does nothing otherwise. |
protected void |
terminatePrecedingActivities()
Terminates preceding activities that are still running. |
String |
toString()
Returns a string representation of the connector 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.fc.WTObject |
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo |
Methods inherited from class java.lang.Object |
clone, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
private static final String RESOURCE
private static final String CLASSNAME
public static final String CONNECTOR_FUNCTION
private static int CONNECTOR_FUNCTION_UPPER_LIMIT
private WfConnectorFunction connectorFunction
public static final String STATE
private static int STATE_UPPER_LIMIT
private WfConnectorState state
public static final String FIRING_THRESHOLD
Initial value is zero that, in practice, is equivalent to an OR connector
because for a connector to fire its outgoing links is necessary that
an incoming link be fired.
Supported API: false
private int firingThreshold
public static final String NUMBER_PREDECESSORS
private int numberPredecessors
public static final String NUMBER_FIRED_PREDECESSORS
private int numberFiredPredecessors
public static final String TEMPLATE
private WfNodeTemplateReference template
public static final String CONNECTOR_TYPE
private static int CONNECTOR_TYPE_UPPER_LIMIT
private WfConnectorType connectorType
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
private static int FIRED_LINK_LIST_UPPER_LIMIT
private FiredLinkVector firedLinkList
public static final String TERMINATE_ACTIVITIES
private boolean terminateActivities
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
Constructor Detail |
public WfConnector()
Method Detail |
public void writeExternal(ObjectOutput output) throws IOException
writeExternal
in interface Externalizable
writeExternal
in class WTObject
output
-
IOException
public void readExternal(ObjectInput input) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
readExternal
in class WTObject
input
-
IOException
ClassNotFoundException
protected boolean readVersion(WfConnector 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 WTObject
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 WTObject
input
-
SQLException
DatastoreException
public String getConceptualClassname()
getConceptualClassname
in interface NetFactor
public WfConnectorFunction getConnectorFunction()
protected void setConnectorFunction(WfConnectorFunction a_ConnectorFunction)
a_ConnectorFunction
- public WfConnectorState getState()
protected void setState(WfConnectorState a_State)
a_State
- public int getFiringThreshold()
Initial value is zero that, in practice, is equivalent to an OR
connector because for a connector to fire its outgoing links is necessary
that an incoming link be fired.
Supported API: false
public void setFiringThreshold(int a_FiringThreshold)
Initial value is zero that, in practice, is equivalent to an OR
connector because for a connector to fire its outgoing links is necessary
that an incoming link be fired.
Supported API: false
a_FiringThreshold
- public int getNumberPredecessors()
public void setNumberPredecessors(int a_NumberPredecessors)
a_NumberPredecessors
- public int getNumberFiredPredecessors()
protected void setNumberFiredPredecessors(int a_NumberFiredPredecessors)
a_NumberFiredPredecessors
- public WfNodeTemplateReference getTemplate()
public void setTemplate(WfNodeTemplateReference a_Template)
a_Template
- public WfConnectorType getConnectorType()
protected void setConnectorType(WfConnectorType a_ConnectorType)
a_ConnectorType
- public WfRouterType getRouterType()
public void setRouterType(WfRouterType a_RouterType)
a_RouterType
- public UserEventVector getUserEventList()
public void setUserEventList(UserEventVector a_UserEventList)
a_UserEventList
- public boolean isTerminateActivities()
public void setTerminateActivities(boolean a_TerminateActivities)
a_TerminateActivities
- public String toString()
public WfConnector changeState(WfConnectorAction action) throws WTException
action
-
WTException
public static WfConnector newWfConnector(WfContainer container, WfConnectorFunction function, WfConnectorType type) throws WTException
container
- function
- type
-
WTException
protected void initialize(WfContainer container, WfConnectorFunction function, WfConnectorType type) throws WTException
container
- function
- type
-
WTException
public void fireInput(ObjectReference link_ref) throws WTException
link_ref
-
WTException
protected void fire(boolean is_immediate) throws WTException
is_immediate
-
WTException
protected WfConnector addOneToThreshold() throws WTException
WTException
protected WfConnector subtractOneFromThreshold() throws WTException
WTException
public WfContainerReference getParentProcessRef()
getParentProcessRef
in interface WfNode
public void setParentProcessRef(WfContainerReference a_ParentProcessRef)
setParentProcessRef
in interface WfNode
a_ParentProcessRef
- public ObjectReference getTemplateReference()
getTemplateReference
in interface WfNode
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
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
protected void terminatePrecedingActivities() throws WTException
WTException
public Object evaluateRouterExpression() throws WTException
WTException
protected void propagateEvent(Object event) throws WTException
WTException
public void fire() throws WTException
WTException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |