wt.projmgmt.definer
Class ProjectProxyTemplate

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.definer.WfTemplateObject
              wt.projmgmt.definer.ProjectProxyTemplate

All Implemented Interfaces:

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

public class ProjectProxyTemplate

extends WfTemplateObject

implements ProjectNodeTemplate, Externalizable

A ProjectProxyTemplate is the template associated with a project proxy.

Use the newProjectProxyTemplate static factory method(s), not the ProjectProxyTemplate 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:

Milestone, Serialized Form

Field Summary

private static String	CLASSNAME
private ExecutionConfiguration	configuration
static long	EXTERNALIZATION_VERSION_UID
private WfNodeTemplateReference	inConnectorRef
protected static long	OLD_FORMAT_VERSION_UID
private static int	PROJECT_CATEGORY_UPPER_LIMIT
private ProjectCategory	projectCategory
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, 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.projmgmt.definer.ProjectNodeTemplate

IN_CONNECTOR_REF

Fields inherited from interface wt.projmgmt.definer.ProjMgmtTemplateObject

CONFIGURATION, PROJECT_CATEGORY

Fields inherited from interface wt.inf.container.WTContained

CONTAINER, CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.workflow.definer.WfNodeTemplate

PARENT_TEMPLATE, ROUTER_TYPE, USER_EVENT_LIST, X_COORD, Y_COORD

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

ProjectProxyTemplate()

Method Summary

WfTemplateObject	copy() Creates template object of the same type and with the same attributes as the object.
WfTemplateObject	copy(WTContainerRef context_ref) Produces a transient, shallow copy of the object.
protected void	copyAttributes(WfTemplateObject template) Copies milestone template attributes to the project proxy template passed as argument.
WfNode	createWfNode(WfContainer container) Instantiates a project proxy that references the template.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
ExecutionConfiguration	getConfiguration() Gets the value of the attribute: CONFIGURATION.
Class	getExecObjClass() Returns the instantiation class that corresponds to the template.
WfConnectorTemplate	getInConnector() Supported API: false
WfNodeTemplateReference	getInConnectorRef() Gets the value of the attribute: IN_CONNECTOR_REF.
ProjectCategory	getProjectCategory() Gets the value of the attribute: PROJECT_CATEGORY.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
protected void	initialize(WTContainerRef context_ref) Supported API: false
static ProjectProxyTemplate	newProjectProxyTemplate() Deprecated. objects created with this constructor go into the classic container: use constructor with the container as argument.
static ProjectProxyTemplate	newProjectProxyTemplate(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(ProjectProxyTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttributes(ProjectProxy proxy) Sets attributes in the project proxy passed as argument.
void	setConfiguration(ExecutionConfiguration a_Configuration) Sets the value of the attribute: CONFIGURATION.
void	setInConnectorRef(WfNodeTemplateReference a_InConnectorRef) Sets the value of the attribute: IN_CONNECTOR_REF.
void	setProjectCategory(ProjectCategory a_ProjectCategory) Sets the value of the attribute: PROJECT_CATEGORY.
String	toString() Creates a string representation of the 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.definer.WfTemplateObject

addOverdueNotificationRole, addUserEvent, getCategory, getContainer, getContainerName, getContainerReference, getContextSignature, getDescription, getDestinationActions, getDuration, getEventConfiguration, getIconName, getIdentity, getName, getOverdueNotificationList, getOverdueNotificationRoles, getParentLinkRef, getParentTemplate, getPredecessors, getProcessDuration, getResponsibleRole, getRouterType, getSourceEvents, getStartDelay, getStartProcessDelay, getSuccessors, getTimePastDeadline, getTimeToDeadline, getUserEventList, getUserEvents, getXCoord, getYCoord, readVersion, removeOverdueNotificationRole, removeUserEvent, setAttributes, setBasicAttributes, setCategory, setContainer, setContainerReference, setContextSignature, setDescription, setDuration, setEventConfiguration, setIconName, setLinkRef, setName, setOverdueNotificationList, setParentLinkRef, setParentTemplate, setProcessDuration, setResponsibleRole, 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.inf.container.WTContained

getContainer, getContainerName, getContainerReference, setContainer, setContainerReference

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.workflow.definer.WfNodeTemplate

addUserEvent, getDestinationActions, getParentTemplate, getPredecessors, getRouterType, getSourceEvents, getSuccessors, getUserEventList, getUserEvents, getXCoord, getYCoord, removeUserEvent, setRouterType, setUserEventList, setXCoord, setYCoord

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

inConnectorRef

private WfNodeTemplateReference inConnectorRef

configuration

private ExecutionConfiguration configuration

PROJECT_CATEGORY_UPPER_LIMIT

private static int PROJECT_CATEGORY_UPPER_LIMIT

projectCategory

private ProjectCategory projectCategory

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

ProjectProxyTemplate

public ProjectProxyTemplate()

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 WfTemplateObject

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 WfTemplateObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ProjectProxyTemplate 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 WfTemplateObject

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 WfTemplateObject

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

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Instantiates a project proxy that references the template.

Supported API: false

Specified by:

createWfNode in interface WfNodeTemplate

Parameters:

container -

Returns:

WfNode

Throws:

WTException

setAttributes

public void setAttributes(ProjectProxy proxy)
                   throws WTException

Sets attributes in the project proxy passed as argument. This is called by createWfNode.

Supported API: false

Parameters:

proxy -

Throws:

WTException

toString

public String toString()

Creates a string representation of the object.

Supported API: false

Overrides:

toString in class WfTemplateObject

Returns:

String

copy

public WfTemplateObject copy()
                      throws WTException

Creates template object of the same type and with the same attributes as the object.

Supported API: false

Specified by:

copy in class WfTemplateObject

Returns:

WfTemplateObject

Throws:

WTException

getExecObjClass

public Class getExecObjClass()

Returns the instantiation class that corresponds to the template.

Supported API: false

Specified by:

getExecObjClass in class WfTemplateObject

Returns:

Class

copyAttributes

protected void copyAttributes(WfTemplateObject template)

Copies milestone template attributes to the project proxy template passed as argument. The argument must be a project proxy template.

Supported API: false

Overrides:

copyAttributes in class WfTemplateObject

Parameters:

template -

newProjectProxyTemplate

public static ProjectProxyTemplate newProjectProxyTemplate()
                                                    throws WTException

Deprecated. objects created with this constructor go into the classic container: use constructor with the container as argument.

Supported API: false

Returns:

ProjectProxyTemplate

Throws:

WTException

newProjectProxyTemplate

public static ProjectProxyTemplate newProjectProxyTemplate(WTContainerRef context_ref)
                                                    throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

ProjectProxyTemplate

Throws:

WTException

copy

public WfTemplateObject copy(WTContainerRef context_ref)
                      throws WTException

Produces a transient, shallow copy of the object. This method is abstract and should be implemented by all concrete subclasses of WfTemplateObject.

Supported API: false

Specified by:

copy in class WfTemplateObject

Parameters:

context_ref -

Returns:

WfTemplateObject

Throws:

WTException

getInConnectorRef

public WfNodeTemplateReference getInConnectorRef()

Gets the value of the attribute: IN_CONNECTOR_REF.

Supported API: false

Specified by:

getInConnectorRef in interface ProjectNodeTemplate

Returns:

WfNodeTemplateReference

setInConnectorRef

public void setInConnectorRef(WfNodeTemplateReference a_InConnectorRef)

Sets the value of the attribute: IN_CONNECTOR_REF.

Supported API: false

Specified by:

setInConnectorRef in interface ProjectNodeTemplate

Parameters:

a_InConnectorRef -

getInConnector

public WfConnectorTemplate getInConnector()
                                   throws WTException

Supported API: false

Specified by:

getInConnector in interface ProjectNodeTemplate

Returns:

WfConnectorTemplate

Throws:

WTException

getConfiguration

public ExecutionConfiguration getConfiguration()

Gets the value of the attribute: CONFIGURATION. Project management execution parameters. Conceptually it is a list of boolean flags that indicated the presence or absence of a certain property. For example, whether or not a certain event should be stored in the database. It is implemented as a unsigned long, which effectively limits the number of possible flags to 64.

Supported API: false

Specified by:

getConfiguration in interface ProjMgmtTemplateObject

Returns:

ExecutionConfiguration

setConfiguration

public void setConfiguration(ExecutionConfiguration a_Configuration)

Sets the value of the attribute: CONFIGURATION. Project management execution parameters. Conceptually it is a list of boolean flags that indicated the presence or absence of a certain property. For example, whether or not a certain event should be stored in the database. It is implemented as a unsigned long, which effectively limits the number of possible flags to 64.

Supported API: false

Specified by:

setConfiguration in interface ProjMgmtTemplateObject

Parameters:

a_Configuration -

getProjectCategory

public ProjectCategory getProjectCategory()

Gets the value of the attribute: PROJECT_CATEGORY. Classification attribute for project management objects. The intent is to help identification and retrieval.

Supported API: false

Specified by:

getProjectCategory in interface ProjMgmtTemplateObject

Returns:

ProjectCategory

setProjectCategory

public void setProjectCategory(ProjectCategory a_ProjectCategory)

Sets the value of the attribute: PROJECT_CATEGORY. Classification attribute for project management objects. The intent is to help identification and retrieval.

Supported API: false

Specified by:

setProjectCategory in interface ProjMgmtTemplateObject

Parameters:

a_ProjectCategory -

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 WfTemplateObject

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 WfTemplateObject

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: Simple

Supported API: false

Overrides:

initialize in class WfTemplateObject

Throws:

WTException

initialize

protected void initialize(WTContainerRef context_ref)
                   throws WTException

Description copied from class: WfTemplateObject

Supported API: false

Overrides:

initialize in class WfTemplateObject

Parameters:

context_ref -

Throws:

WTException