wt.workflow.definer
Class WfBlockTemplate

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.definer.WfTemplateObject
              wt.workflow.definer.WfContainerTemplate
                  wt.workflow.definer.WfBlockTemplate

All Implemented Interfaces:

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

Direct Known Subclasses:

ProjectPlanTemplate, SummaryActivityTemplate

public class WfBlockTemplate

extends WfContainerTemplate

implements Externalizable

Class that represents a workflow block. Blocks, like processes, are composed of activities and connectors. This design allows the reuse of most of the mechanisms created for definition and execution of processes. There are differences though. Blocks don't have separate existences from the templates on which they are defined. They can't be used in more than one host process and are not placed in folders.

• Blocks don't have internal variables; the input and output is done directly with the host process. The variable mapping is defined accordingly.
• Blocks don't have the following attributes either: category, enabled, registered, duration and event configuration.
• Blocks don't have events and routing capabilities.
• Blocks may have an evaluation expression that returns a boolean value. This expression accesses the host process variable.

Blocks, however, have a name, description, a state, an icon name, as well as x and y coordinates.

Use the newWfBlockTemplate static factory method(s), not the WfBlockTemplate 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

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.workflow.definer.WfTemplateObject

CATEGORY, CONTAINER, CONTEXT_SIGNATURE, DESCRIPTION, DURATION, EVENT_CONFIGURATION, ICON_NAME, NAME, ORG_ATTRIBUTE, OVERDUE_NOTIFICATION_LIST, PARENT_LINK_REF, PROCESS_DURATION, R30_EXTERNALIZATION_VERSION_UID, R60_EXTERNALIZATION_VERSION_UID, RESPONSIBLE_ROLE, SELF_VARIABLE_NAME, START_DELAY, START_PROCESS_DELAY, TIME_PAST_DEADLINE, TIME_TO_DEADLINE

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.workflow.definer.WfNodeTemplate

PARENT_TEMPLATE, ROUTER_TYPE, USER_EVENT_LIST, X_COORD, Y_COORD

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

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

WfBlockTemplate()

Method Summary

WfTemplateObject	copy() Produces a transient, shallow copy of the object.
WfTemplateObject	copy(WTContainerRef context_ref) Produces a transient, shallow copy of the object.
void	copyAttributes(WfTemplateObject template) Copies all attributes into the template object passed as argument.
WfNode	createWfNode(WfContainer container) Creates a requester activity and a block process instantiated from the template given the containing process.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
WfTemplateCategory	getCategory() Returns parent process' category if it exists; null if block is stand-alone.
String	getConceptualClassname() Deprecated.
ProcessDataInfo	getContextSignature() Returns parent process' context signature if it exists; or its own if block is stand-alone.
WfEventConfiguration	getEventConfiguration() Returns parent process' event configuration if it exists; or its own if block is stand-alone.
Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
RoleVector	getOverdueNotificationList() Returns parent process' context overdue notification list if it exists; or its own if block is stand-alone.
WfProcessTemplate	getParentProcess() Returns the innermost process template that owns the block.
Role	getResponsibleRole() Returns parent process' responsible role if it exists; or its own if block is stand-alone.
WfRouterType	getRouterType() Returns WfRouterType.NONE.
UserEventVector	getUserEventList() Returns empty user event list.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static WfBlockTemplate	newWfBlockTemplate() Deprecated. activities created with this constructor are placed in the classic container.
static WfBlockTemplate	newWfBlockTemplate(WTContainerRef context_ref) Supported API: false
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(WfBlockTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContextSignature(ProcessDataInfo sign) If the block template is nested, nothing happens; otherwise signature is set to the one passed as argument.
void	setEventConfiguration(WfEventConfiguration evt_cfg) If the block template is nested, nothing happens; otherwise the event configuration is set to the one passed as argument.
void	setOverdueNotificationList(RoleVector list) If the block template is nested, nothing happens; otherwise the overdue notification list is set to the one passed as argument.
void	setResponsibleRole(Role resp) If the block template is nested, nothing happens; otherwise the responsible role is set to the one passed as argument.
String	toString() Returns a string representation of the block.
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.definer.WfContainerTemplate

getEndConnectors, getStartConnector, readVersion

Methods inherited from class wt.workflow.definer.WfTemplateObject

addOverdueNotificationRole, addUserEvent, getContainer, getContainerName, getContainerReference, getDescription, getDestinationActions, getDuration, getIconName, getIdentity, getName, getOverdueNotificationRoles, getParentLinkRef, getParentTemplate, getPredecessors, getProcessDuration, getSourceEvents, getStartDelay, getStartProcessDelay, getSuccessors, getTimePastDeadline, getTimeToDeadline, getUserEvents, getXCoord, getYCoord, initialize, initialize, readVersion, removeOverdueNotificationRole, removeUserEvent, setAttributes, setBasicAttributes, setCategory, setContainer, setContainerReference, setDescription, setDuration, setIconName, setLinkRef, setName, setParentLinkRef, setParentTemplate, setProcessDuration, setRouterAttributes, setRouterType, setStartDelay, setStartProcessDelay, setTimePastDeadline, setTimeToDeadline, setUserEventList, setVariableMapping, setXCoord, setYCoord

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

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

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

Constructor Detail

WfBlockTemplate

public WfBlockTemplate()

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 WfContainerTemplate

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 WfContainerTemplate

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfBlockTemplate 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 WfContainerTemplate

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 WfContainerTemplate

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

copy

public WfTemplateObject copy()
                      throws WTException

Produces a transient, shallow copy of the object.

Supported API: false

Specified by:

copy in class WfTemplateObject

Returns:

WfTemplateObject

Throws:

WTException

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Creates a requester activity and a block process instantiated from the template given the containing process. Returns the requester activity.

Supported API: false

Specified by:

createWfNode in interface WfNodeTemplate

Parameters:

container -

Returns:

WfNode

Throws:

WTException

copyAttributes

public void copyAttributes(WfTemplateObject template)

Copies all attributes into the template object passed as argument.

Supported API: false

Overrides:

copyAttributes in class WfTemplateObject

Parameters:

template -

toString

public String toString()

Returns a string representation of the block. Used mostly for debugging purposes: not appropriate for GUI use.

Supported API: false

Overrides:

toString in class WfTemplateObject

Returns:

String

getCategory

public WfTemplateCategory getCategory()

Returns parent process' category if it exists; null if block is stand-alone.

Supported API: false

Overrides:

getCategory in class WfTemplateObject

Returns:

WfTemplateCategory

getContextSignature

public ProcessDataInfo getContextSignature()

Returns parent process' context signature if it exists; or its own if block is stand-alone.

Supported API: false

Overrides:

getContextSignature in class WfTemplateObject

Returns:

ProcessDataInfo

getEventConfiguration

public WfEventConfiguration getEventConfiguration()

Returns parent process' event configuration if it exists; or its own if block is stand-alone.

Supported API: false

Overrides:

getEventConfiguration in class WfTemplateObject

Returns:

WfEventConfiguration

getRouterType

public WfRouterType getRouterType()

Returns WfRouterType.NONE.

Supported API: false

Specified by:

getRouterType in interface WfNodeTemplate

Overrides:

getRouterType in class WfTemplateObject

Returns:

WfRouterType

getUserEventList

public UserEventVector getUserEventList()

Returns empty user event list. (Blocks can't be used as routers.)

Supported API: false

Specified by:

getUserEventList in interface WfNodeTemplate

Overrides:

getUserEventList in class WfTemplateObject

Returns:

UserEventVector

getResponsibleRole

public Role getResponsibleRole()

Returns parent process' responsible role if it exists; or its own if block is stand-alone.

Supported API: false

Overrides:

getResponsibleRole in class WfTemplateObject

Returns:

Role

getOverdueNotificationList

public RoleVector getOverdueNotificationList()

Returns parent process' context overdue notification list if it exists; or its own if block is stand-alone.

Supported API: false

Overrides:

getOverdueNotificationList in class WfTemplateObject

Returns:

RoleVector

getParentProcess

public WfProcessTemplate getParentProcess()
                                   throws WTException

Returns the innermost process template that owns the block. Recursively retrieves the container template until a process template is found. This template is then returned. If the block is not persistent returns 'null.'

Supported API: false

Returns:

WfProcessTemplate

Throws:

WTException

setContextSignature

public void setContextSignature(ProcessDataInfo sign)

If the block template is nested, nothing happens; otherwise signature is set to the one passed as argument.

Supported API: false

Overrides:

setContextSignature in class WfTemplateObject

Parameters:

sign -

setEventConfiguration

public void setEventConfiguration(WfEventConfiguration evt_cfg)

If the block template is nested, nothing happens; otherwise the event configuration is set to the one passed as argument.

Supported API: false

Overrides:

setEventConfiguration in class WfTemplateObject

Parameters:

evt_cfg -

setResponsibleRole

public void setResponsibleRole(Role resp)

If the block template is nested, nothing happens; otherwise the responsible role is set to the one passed as argument.

Supported API: false

Overrides:

setResponsibleRole in class WfTemplateObject

Parameters:

resp -

setOverdueNotificationList

public void setOverdueNotificationList(RoleVector list)

If the block template is nested, nothing happens; otherwise the overdue notification list is set to the one passed as argument.

Supported API: false

Overrides:

setOverdueNotificationList in class WfTemplateObject

Parameters:

list -

getExecObjClass

public Class getExecObjClass()

Returns the class of the execution object instantiated by theis class. It is the same returned by the createWfNode method.

Supported API: false

Specified by:

getExecObjClass in class WfTemplateObject

Returns:

Class

newWfBlockTemplate

public static WfBlockTemplate newWfBlockTemplate()
                                          throws WTException

Deprecated. activities created with this constructor are placed in the classic container.

Supported API: false

Returns:

WfBlockTemplate

Throws:

WTException

newWfBlockTemplate

public static WfBlockTemplate newWfBlockTemplate(WTContainerRef context_ref)
                                          throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

WfBlockTemplate

Throws:

WTException

copy

public WfTemplateObject copy(WTContainerRef context_ref)
                      throws WTException

Produces a transient, shallow copy of the object.

Supported API: false

Specified by:

copy in class WfTemplateObject

Parameters:

context_ref -

Returns:

WfTemplateObject

Throws:

WTException

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 WfContainerTemplate

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 WfContainerTemplate

Returns:

int