wt.projmgmt.execution
Class Milestone

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.engine.WfExecutionObject
              wt.workflow.engine.WfActivity
                  wt.projmgmt.execution.Milestone

All Implemented Interfaces:

AccessControlled, BusinessInformation, Comparable, DeliverableHolder, DisplayIdentification, DomainAdministered, ExecutionObject, Externalizable, Indexable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, ProjectNode, RecentlyVisited, Serializable, SubjectOfNotebook, WfNode, WTContained

public class Milestone

extends WfActivity

implements ProjectNode, DeliverableHolder, Externalizable

The Milestone class represents a notable point in the execution of a project. A Milestone contains deliverables and also an "owner." Most of the values for the attributes of a milestone is obtained from its contained deliverables. The completion of the deliverables contained in the MIlestone usually signals that the Milestone is completed (met). The owner, however, can override these rolled up values.

Use the newMilestone static factory method(s), not the Milestone 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: true

Extendable: false

See Also:

Deliverable, Serialized Form

Field Summary

private TimeToElapse	afterDeadline
private TimeToElapse	beforeDeadline
private static String	CLASSNAME
private ExecutionConfiguration	configuration
protected QueryResult	containedNodes
protected Double	currentCost
private Currency	currentWorkCost
protected TimeToElapse	duration
private boolean	enabled
protected Timestamp	estimatedFinish
private Timestamp	estimatedFinishDate
static long	EXTERNALIZATION_VERSION_UID
private static int	HEALTH_STATUS_UPPER_LIMIT
private ProjectHealthStatus	healthStatus
private int	id
private ObjectReference	inConnectorRef
private IndexerSet	indexerSet
private Timestamp	inheritedDeadline
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private int	percentComplete
private Work	performedWork
static String	PLAN Label for the attribute.
private ObjectReference	planReference
protected QueryResult	predecessors
private static int	PROJECT_CATEGORY_UPPER_LIMIT
private ProjectCategory	projectCategory
private static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
private static int	RISK_DESCRIPTION_UPPER_LIMIT
private static int	RISK_VALUE_UPPER_LIMIT
private String	riskDescription
private ProjectRiskValue	riskValue
(package private) static long	serialVersionUID
private static int	STATUS_DESCRIPTION_UPPER_LIMIT
private String	statusDescription
protected QueryResult	successors
protected Double	totalCost
private Work	totalWork
private Currency	totalWorkCost
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.projmgmt.execution.ProjectNode

ID, IN_CONNECTOR_REF, PLAN_REFERENCE

Fields inherited from interface wt.projmgmt.execution.ExecutionObject

AFTER_DEADLINE, BEFORE_DEADLINE, CONFIGURATION, CURRENT_WORK_COST, ENABLED, ESTIMATED_FINISH_DATE, HEALTH_STATUS, INHERITED_DEADLINE, PERCENT_COMPLETE, PERFORMED_WORK, PROJECT_CATEGORY, RISK_DESCRIPTION, RISK_VALUE, STATUS_DESCRIPTION, TOTAL_WORK, TOTAL_WORK_COST

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.inf.container.WTContained

CONTAINER, CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.workflow.engine.WfNode

PARENT_PROCESS_REF

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

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

Milestone()

Method Summary

private boolean	allDeliverablesClosed()
ExecutionObject	changeState(ProjectState new_state) Changes the state of the execution object to the workflow state that corresponds to the project state passed as argument.
WfExecutionObject	changeState(WfTransition transition) Change the workflow state of the object given a transition as argument.
WfExecutionObject	changeState(WfTransition transition, boolean propagate) Change the workflow state of the object given a transition as argument.
WfExecutionObject	changeState(WfTransition transition, boolean immediate, boolean propagate) Change the workflow state of the object given a transition as argument.
int	compareTo(Object arg0) Compares this object with the specified object for order.
protected void	computeDeadline(long time) Overrides WfActivity 's method fo same name.
WfTemplateObject	createTemplateObject() Creates a milestone template given the milestone.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
TimeToElapse	getAfterDeadline() Gets the value of the attribute: AFTER_DEADLINE.
TimeToElapse	getBeforeDeadline() Gets the value of the attribute: BEFORE_DEADLINE.
String	getConceptualClassname() Deprecated.
ExecutionConfiguration	getConfiguration() Gets the value of the attribute: CONFIGURATION.
QueryResult	getContainedNodes() Returns object's ContainedNodes (calculated cached value) Supported API: false
ProcessData	getContext() Supported API: false
Double	getCurrentCost() Returns object's current cost.
Currency	getCurrentWorkCost() Gets the value of the attribute: CURRENT_WORK_COST.
Timestamp	getDeadline() Returns object's deadline.
String	getDescription() Returns object description.
TimeToElapse	getDuration() Returns object's Duration.
Timestamp	getEndTime() Returns time execution of object finished.
Timestamp	getEstimatedFinish() Returns object's estimated finish.
Timestamp	getEstimatedFinishDate() Gets the value of the attribute: ESTIMATED_FINISH_DATE.
ProjectState	getExecutionState() Returns project execution state that corresponds to internal object's workflow state.
Timestamp	getFinishDate(TimeToElapse days) Returns estimated finish date for the object given the duration given in TimeToElapse.
ProjectHealthStatus	getHealthStatus() Gets the value of the attribute: HEALTH_STATUS.
int	getId() Gets the value of the attribute: ID.
WfConnector	getInConnector() Supported API: false
ObjectReference	getInConnectorRef() Gets the value of the attribute: IN_CONNECTOR_REF.
IndexerSet	getIndexerSet() Gets the value of the attribute: INDEXER_SET.
Timestamp	getInheritedDeadline() Gets the value of the attribute: INHERITED_DEADLINE.
String	getName() Returns name of the object.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
int	getPercentComplete() Gets the value of the attribute: PERCENT_COMPLETE.
Work	getPerformedWork() Gets the value of the attribute: PERFORMED_WORK.
ProjectPlan	getPlan() Gets the object for the association that plays role: PLAN.
ObjectReference	getPlanReference() Gets the value of the attribute: PLAN_REFERENCE.
QueryResult	getPredecessors() Returns object's Predecessors (calculated cached value) Supported API: false
ProjectCategory	getProjectCategory() Gets the value of the attribute: PROJECT_CATEGORY.
String	getRiskDescription() Gets the value of the attribute: RISK_DESCRIPTION.
ProjectRiskValue	getRiskValue() Gets the value of the attribute: RISK_VALUE.
Timestamp	getStartTime() Returns time execution of object started.
String	getStatusDescription() Gets the value of the attribute: STATUS_DESCRIPTION.
QueryResult	getSuccessors() Returns object's successors.
WfTemplateObject	getTemplateObject() Returns template to which the execution object is associated.
Double	getTotalCost() Returns object's total cost.
Work	getTotalWork() Gets the value of the attribute: TOTAL_WORK.
Currency	getTotalWorkCost() Gets the value of the attribute: TOTAL_WORK_COST.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WfContainer container) Supported API: false
boolean	isEnabled() Gets the value of the attribute: ENABLED.
static Milestone	newMilestone(WfContainer container) Milestone constructor.
private void	planReferenceValidate(ObjectReference a_PlanReference)
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(Milestone thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAfterDeadline(TimeToElapse a_AfterDeadline) Sets the value of the attribute: AFTER_DEADLINE.
void	setBeforeDeadline(TimeToElapse a_BeforeDeadline) Sets the value of the attribute: BEFORE_DEADLINE.
void	setConfiguration(ExecutionConfiguration a_Configuration) Sets the value of the attribute: CONFIGURATION.
void	setContainedNodes(QueryResult a_result) sets object's ContainedNodes (calculated cached value) Supported API: false
void	setContext(ProcessData vars) Supported API: false
void	setCurrentCost(Double cost) set object's current cost.
void	setCurrentWorkCost(Currency a_CurrentWorkCost) Sets the value of the attribute: CURRENT_WORK_COST.
void	setDeadline(Timestamp time) Sets object's deadline.
void	setDescription(String desc) Sets object description.
void	setDuration(TimeToElapse a_time) set object's Duration.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setEndTime(Timestamp time) Sets the time the execution of object finished.
void	setEstimatedFinish(Timestamp a_time) set object's estimated finish.
void	setEstimatedFinishDate(Timestamp a_EstimatedFinishDate) Sets the value of the attribute: ESTIMATED_FINISH_DATE.
void	setExecutionState(ProjectState state) Setsinternal object's workflow state that corresponds to project execution state passed as argument.
void	setHealthStatus(ProjectHealthStatus a_HealthStatus) Sets the value of the attribute: HEALTH_STATUS.
void	setId(int a_Id) Sets the value of the attribute: ID.
void	setInConnectorRef(ObjectReference a_InConnectorRef) Sets the value of the attribute: IN_CONNECTOR_REF.
void	setIndexerSet(IndexerSet a_IndexerSet) Sets the value of the attribute: INDEXER_SET.
void	setInheritedDeadline(Timestamp a_InheritedDeadline) Sets the value of the attribute: INHERITED_DEADLINE.
void	setName(String name) Sets name of the object.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
void	setPercentComplete(int a_PercentComplete) Sets the value of the attribute: PERCENT_COMPLETE.
void	setPerformedWork(Work a_PerformedWork) Sets the value of the attribute: PERFORMED_WORK.
void	setPlan(ProjectPlan a_Plan) Sets the object for the association that plays role: PLAN.
void	setPlanReference(ObjectReference a_PlanReference) Sets the value of the attribute: PLAN_REFERENCE.
void	setPredecessors(QueryResult a_result) sets object's Predecessors (calculated cached value) Supported API: false
void	setProjectCategory(ProjectCategory a_ProjectCategory) Sets the value of the attribute: PROJECT_CATEGORY.
void	setRiskDescription(String a_RiskDescription) Sets the value of the attribute: RISK_DESCRIPTION.
void	setRiskValue(ProjectRiskValue a_RiskValue) Sets the value of the attribute: RISK_VALUE.
void	setStartTime(Timestamp time) Sets the s time execution of object started.
void	setStatusDescription(String a_StatusDescription) Sets the value of the attribute: STATUS_DESCRIPTION.
void	setSuccessors(QueryResult a_result) sets object's successors.
void	setTotalCost(Double cost) set object's total cost.
void	setTotalWork(Work a_TotalWork) Sets the value of the attribute: TOTAL_WORK.
void	setTotalWorkCost(Currency a_TotalWorkCost) Sets the value of the attribute: TOTAL_WORK_COST.
String	toString() Produces string representation of the milestone.
void	updateDeadline(Timestamp start) Supported API: false
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.WfActivity

checkSuspendedProcess, complete, computeDeadline, computeTimeToStart, deleteActivity, doAbortTransition, doCompleteTransition, doDisableTransition, doEnableTransition, doResetTransition, doResumeTransition, doSkipTransition, doStartTransition, doSuspendTransition, doTerminateTransition, doWork, evaluateRouterExpression, getInputVariableMap, getOutputVariableMap, getParentProcess, getParentProcessReadOnly, getParentProcessRef, getRouterEvent, getRouterType, getTemplateReference, getTripCount, getUserEventList, getWfException, hasRouterExpression, propagateEvent, readValues, readVersion, registerEvent, setInputVariableMap, setOutputVariableMap, setParentProcessRef, setRouterType, setTripCount, setUserEventList, updateWfAssigneeNotification, updateWfDueDate, updateWfDuration, writeValues

Methods inherited from class wt.workflow.engine.WfExecutionObject

calculateTimePastDeadline, calculateTimeToDeadline, changeDeadline, changeStateAttributes, computeTimePastDeadline, computeTimeToDeadline, evaluateExpression, getAdSQEN, getAlertTime, getChangeStateTime, getContainer, getContainerName, getContainerReference, getDeadlineDuration, getDSQEN, getEventConfiguration, getIdentity, getKey, getPdSQEN, getPriority, getState, getSuspendTime, getTemplate, getTimePastDeadline, getTimeToDeadline, getTimeToStart, getVarDueDate, getVarDuration, getVarNotification, initialize, initialize, isOverdue, readVersion, removeDeadlineQueueEntries, resetValues, setAdSQEN, setAlertTime, setChangeStateTime, setContainer, setContainerReference, setDeadlineDuration, setDSQEN, setEventConfiguration, setKey, setPdSQEN, setPriority, setState, setSuspendTime, setTemplate, setTimePastDeadline, setTimeToDeadline, setTimeToStart, 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, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.notify.Notifiable

getEventSet, setEventSet

Methods inherited from interface wt.inf.container.WTContained

getContainer, getContainerName, getContainerReference, setContainer, setContainerReference

Methods inherited from interface wt.workflow.engine.WfNode

getParentProcessRef, getTemplateReference, setParentProcessRef

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

inConnectorRef

private ObjectReference inConnectorRef

id

private int id

PLAN

public static final String PLAN

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

planReference

private ObjectReference planReference

afterDeadline

private TimeToElapse afterDeadline

beforeDeadline

private TimeToElapse beforeDeadline

configuration

private ExecutionConfiguration configuration

currentWorkCost

private Currency currentWorkCost

enabled

private boolean enabled

estimatedFinishDate

private Timestamp estimatedFinishDate

HEALTH_STATUS_UPPER_LIMIT

private static int HEALTH_STATUS_UPPER_LIMIT

healthStatus

private ProjectHealthStatus healthStatus

inheritedDeadline

private Timestamp inheritedDeadline

percentComplete

private int percentComplete

performedWork

private Work performedWork

PROJECT_CATEGORY_UPPER_LIMIT

private static int PROJECT_CATEGORY_UPPER_LIMIT

projectCategory

private ProjectCategory projectCategory

RISK_DESCRIPTION_UPPER_LIMIT

private static int RISK_DESCRIPTION_UPPER_LIMIT

riskDescription

private String riskDescription

RISK_VALUE_UPPER_LIMIT

private static int RISK_VALUE_UPPER_LIMIT

riskValue

private ProjectRiskValue riskValue

STATUS_DESCRIPTION_UPPER_LIMIT

private static int STATUS_DESCRIPTION_UPPER_LIMIT

statusDescription

private String statusDescription

totalWork

private Work totalWork

totalWorkCost

private Currency totalWorkCost

ownership

private Ownership ownership

indexerSet

private IndexerSet indexerSet

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

R60_EXTERNALIZATION_VERSION_UID

private static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

estimatedFinish

protected Timestamp estimatedFinish

predecessors

protected QueryResult predecessors

successors

protected QueryResult successors

duration

protected TimeToElapse duration

containedNodes

protected QueryResult containedNodes

totalCost

protected Double totalCost

currentCost

protected Double currentCost

Constructor Detail

Milestone

public Milestone()

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 WfActivity

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 WfActivity

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Milestone 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 WfActivity

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 WfActivity

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

changeState

public WfExecutionObject changeState(WfTransition transition)
                              throws WTException

Change the workflow state of the object given a transition as argument.

Supported API: false

Overrides:

changeState in class WfActivity

Parameters:

transition -

Returns:

WfExecutionObject

Throws:

WTException

changeState

public WfExecutionObject changeState(WfTransition transition,
                                     boolean propagate)
                              throws WTException

Change the workflow state of the object given a transition as argument. The state change is not propagated to successor nodes if the propagate argument is 'false.' Otherwise the event is propagated normally.

Supported API: false

Overrides:

changeState in class WfActivity

Parameters:

transition -

propagate -

Returns:

WfExecutionObject

Throws:

WTException

changeState

public WfExecutionObject changeState(WfTransition transition,
                                     boolean immediate,
                                     boolean propagate)
                              throws WTException

Change the workflow state of the object given a transition as argument. The state change is not propagated to successor nodes if the propagate argument is 'false.' Otherwise the event is propagated normally. In case propagation is specified, the propagation is done immediately (no queuing) if the argument 'immediate' is true. Normal queuing happens otherwise.

Supported API: false

Overrides:

changeState in class WfActivity

Parameters:

transition -

immediate -

propagate -

Returns:

WfExecutionObject

Throws:

WTException

computeDeadline

protected void computeDeadline(long time)
                        throws WTException

Overrides WfActivity 's method fo same name.

Supported API: false

Overrides:

computeDeadline in class WfActivity

Parameters:

time -

Throws:

WTException

createTemplateObject

public WfTemplateObject createTemplateObject()
                                      throws WTException

Creates a milestone template given the milestone. The template, however, is not persisted.

Supported API: false

Returns:

WfTemplateObject

Throws:

WTException

getContext

public ProcessData getContext()

Supported API: false

Overrides:

getContext in class WfExecutionObject

Returns:

ProcessData

newMilestone

public static Milestone newMilestone(WfContainer container)
                              throws WTException

Milestone constructor. The hosting plan is passed as argument.

Supported API: false

Parameters:

container -

Returns:

Milestone

Throws:

WTException

setContext

public void setContext(ProcessData vars)

Supported API: false

Overrides:

setContext in class WfExecutionObject

Parameters:

vars -

toString

public String toString()

Produces string representation of the milestone.

Supported API: false

Overrides:

toString in class WfActivity

Returns:

String

getInConnectorRef

public ObjectReference getInConnectorRef()

Gets the value of the attribute: IN_CONNECTOR_REF. Reference to a AND connector that serves as input gate to the object. All predecessor nodes should be joined to the input connector rather than directly to the object.

Supported API: false

Specified by:

getInConnectorRef in interface ProjectNode

Returns:

ObjectReference

See Also:

WfConnector

setInConnectorRef

public void setInConnectorRef(ObjectReference a_InConnectorRef)

Sets the value of the attribute: IN_CONNECTOR_REF. Reference to a AND connector that serves as input gate to the object. All predecessor nodes should be joined to the input connector rather than directly to the object.

Supported API: false

Specified by:

setInConnectorRef in interface ProjectNode

Parameters:

a_InConnectorRef -

See Also:

WfConnector

getId

public int getId()

Gets the value of the attribute: ID. Integer that defines the order nodes are displayed. Should start at 1 and be consecutive (no gaps).

Supported API: false

Specified by:

getId in interface ProjectNode

Returns:

int

setId

public void setId(int a_Id)

Sets the value of the attribute: ID. Integer that defines the order nodes are displayed. Should start at 1 and be consecutive (no gaps).

Supported API: false

Specified by:

setId in interface ProjectNode

Parameters:

a_Id -

getInConnector

public WfConnector getInConnector()

Supported API: false

Specified by:

getInConnector in interface ProjectNode

Returns:

WfConnector

compareTo

public int compareTo(Object arg0)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object's id is less than, equal to, or greater than the specified object.
Note: In a given project plan it is the case that this comparison is "consistent with equals," that is (x.compareTo(y)==0) == (x.equals(y)). This consistency is not guaranteed when comparing project nodes from different plans.

Supported API: false

Specified by:

compareTo in interface ProjectNode

Parameters:

arg0 -

Returns:

int

getPlan

public ProjectPlan getPlan()

Gets the object for the association that plays role: PLAN.

Supported API: false

Specified by:

getPlan in interface ProjectNode

Returns:

ProjectPlan

setPlan

public void setPlan(ProjectPlan a_Plan)
             throws WTPropertyVetoException,
                    WTException

Sets the object for the association that plays role: PLAN.

Supported API: false

Specified by:

setPlan in interface ProjectNode

Parameters:

a_Plan -

Throws:

WTPropertyVetoException

WTException

getPlanReference

public ObjectReference getPlanReference()

Gets the value of the attribute: PLAN_REFERENCE.

Supported API: false

Specified by:

getPlanReference in interface ProjectNode

Returns:

ObjectReference

setPlanReference

public void setPlanReference(ObjectReference a_PlanReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: PLAN_REFERENCE.

Supported API: false

Specified by:

setPlanReference in interface ProjectNode

Parameters:

a_PlanReference -

Throws:

WTPropertyVetoException

planReferenceValidate

private void planReferenceValidate(ObjectReference a_PlanReference)
                            throws WTPropertyVetoException

Parameters:

a_PlanReference -

Throws:

WTPropertyVetoException

getAfterDeadline

public TimeToElapse getAfterDeadline()

Gets the value of the attribute: AFTER_DEADLINE. Time past execution object deadline at which point some action may be taken. Typical action is to send notification to responsible parties if object has been completed successfully.

Supported API: false

Specified by:

getAfterDeadline in interface ExecutionObject

Returns:

TimeToElapse

setAfterDeadline

public void setAfterDeadline(TimeToElapse a_AfterDeadline)

Sets the value of the attribute: AFTER_DEADLINE. Time past execution object deadline at which point some action may be taken. Typical action is to send notification to responsible parties if object has been completed successfully.

Supported API: false

Specified by:

setAfterDeadline in interface ExecutionObject

Parameters:

a_AfterDeadline -

getBeforeDeadline

public TimeToElapse getBeforeDeadline()

Gets the value of the attribute: BEFORE_DEADLINE. Time before execution object deadline at which point some action may be taken. Typical action is to send notification to responsible parties alerting them of the approaching deadline, if object hasn't yet been completed successfully.

Supported API: false

Specified by:

getBeforeDeadline in interface ExecutionObject

Returns:

TimeToElapse

setBeforeDeadline

public void setBeforeDeadline(TimeToElapse a_BeforeDeadline)

Sets the value of the attribute: BEFORE_DEADLINE. Time before execution object deadline at which point some action may be taken. Typical action is to send notification to responsible parties alerting them of the approaching deadline, if object hasn't yet been completed successfully.

Supported API: false

Specified by:

setBeforeDeadline in interface ExecutionObject

Parameters:

a_BeforeDeadline -

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 ExecutionObject

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 ExecutionObject

Parameters:

a_Configuration -

getCurrentWorkCost

public Currency getCurrentWorkCost()

Gets the value of the attribute: CURRENT_WORK_COST.

Supported API: true

Specified by:

getCurrentWorkCost in interface ExecutionObject

Returns:

Currency

setCurrentWorkCost

public void setCurrentWorkCost(Currency a_CurrentWorkCost)

Sets the value of the attribute: CURRENT_WORK_COST.

Supported API: true

Specified by:

setCurrentWorkCost in interface ExecutionObject

Parameters:

a_CurrentWorkCost -

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED. Determines whether the object is still relevant. One might want to keep irrelevant objects around if there are events associated with the object, for example.

Supported API: false

Specified by:

isEnabled in interface ExecutionObject

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: ENABLED. Determines whether the object is still relevant. One might want to keep irrelevant objects around if there are events associated with the object, for example.

Supported API: false

Specified by:

setEnabled in interface ExecutionObject

Parameters:

a_Enabled -

getEstimatedFinishDate

public Timestamp getEstimatedFinishDate()

Gets the value of the attribute: ESTIMATED_FINISH_DATE. For milestones, estimate of the time milestone would be met; for project plans and activities, estimated finish date; for deliverables, estimated date it would be satisfied.

Supported API: true

Specified by:

getEstimatedFinishDate in interface ExecutionObject

Returns:

Timestamp

setEstimatedFinishDate

public void setEstimatedFinishDate(Timestamp a_EstimatedFinishDate)

Sets the value of the attribute: ESTIMATED_FINISH_DATE. For milestones, estimate of the time milestone would be met; for project plans and activities, estimated finish date; for deliverables, estimated date it would be satisfied.

Supported API: true

Specified by:

setEstimatedFinishDate in interface ExecutionObject

Parameters:

a_EstimatedFinishDate -

getHealthStatus

public ProjectHealthStatus getHealthStatus()

Gets the value of the attribute: HEALTH_STATUS. Measure of confidence of completing successfully the task or work represented by the execution object. Possible values are GREEN, RED, YELLOW and UNAVAILABLE.

Supported API: true

Specified by:

getHealthStatus in interface ExecutionObject

Returns:

ProjectHealthStatus

See Also:

ProjectHealthStatus

setHealthStatus

public void setHealthStatus(ProjectHealthStatus a_HealthStatus)

Sets the value of the attribute: HEALTH_STATUS. Measure of confidence of completing successfully the task or work represented by the execution object. Possible values are GREEN, RED, YELLOW and UNAVAILABLE.

Supported API: true

Specified by:

setHealthStatus in interface ExecutionObject

Parameters:

a_HealthStatus -

See Also:

ProjectHealthStatus

getInheritedDeadline

public Timestamp getInheritedDeadline()

Gets the value of the attribute: INHERITED_DEADLINE. Earliest date by which a containing object must be met/completed/delivered. In principle, the object's deadline can't be after the inherited deadline.

Supported API: true

Specified by:

getInheritedDeadline in interface ExecutionObject

Returns:

Timestamp

setInheritedDeadline

public void setInheritedDeadline(Timestamp a_InheritedDeadline)

Sets the value of the attribute: INHERITED_DEADLINE. Earliest date by which a containing object must be met/completed/delivered. In principle, the object's deadline can't be after the inherited deadline.

Supported API: true

Specified by:

setInheritedDeadline in interface ExecutionObject

Parameters:

a_InheritedDeadline -

getPercentComplete

public int getPercentComplete()

Gets the value of the attribute: PERCENT_COMPLETE. Quantitative assessment of how close object is from being met/completed/delivered. Values range from 0 and 100 if value has been set; otherwise it is -1.

Supported API: true

Specified by:

getPercentComplete in interface ExecutionObject

Returns:

int

setPercentComplete

public void setPercentComplete(int a_PercentComplete)

Sets the value of the attribute: PERCENT_COMPLETE. Quantitative assessment of how close object is from being met/completed/delivered. Values range from 0 and 100 if value has been set; otherwise it is -1.

Supported API: true

Specified by:

setPercentComplete in interface ExecutionObject

Parameters:

a_PercentComplete -

getPerformedWork

public Work getPerformedWork()

Gets the value of the attribute: PERFORMED_WORK. Work performed in a given project management object. Related to totalWork and percentComplete by the formulas:

 performedWork <= totalWork
 percentComplete = (performedWork / totalWork) * 100
 

Supported API: true

Specified by:

getPerformedWork in interface ExecutionObject

Returns:

Work

setPerformedWork

public void setPerformedWork(Work a_PerformedWork)

Sets the value of the attribute: PERFORMED_WORK. Work performed in a given project management object. Related to totalWork and percentComplete by the formulas:

 performedWork <= totalWork
 percentComplete = (performedWork / totalWork) * 100
 

Supported API: true

Specified by:

setPerformedWork in interface ExecutionObject

Parameters:

a_PerformedWork -

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: true

Specified by:

getProjectCategory in interface ExecutionObject

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: true

Specified by:

setProjectCategory in interface ExecutionObject

Parameters:

a_ProjectCategory -

getRiskDescription

public String getRiskDescription()

Gets the value of the attribute: RISK_DESCRIPTION. Longer textual qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.

Supported API: true

Specified by:

getRiskDescription in interface ExecutionObject

Returns:

String

setRiskDescription

public void setRiskDescription(String a_RiskDescription)

Sets the value of the attribute: RISK_DESCRIPTION. Longer textual qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.

Supported API: true

Specified by:

setRiskDescription in interface ExecutionObject

Parameters:

a_RiskDescription -

getRiskValue

public ProjectRiskValue getRiskValue()

Gets the value of the attribute: RISK_VALUE. Short qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.

Supported API: true

Specified by:

getRiskValue in interface ExecutionObject

Returns:

ProjectRiskValue

See Also:

ProjectRiskValue

setRiskValue

public void setRiskValue(ProjectRiskValue a_RiskValue)

Sets the value of the attribute: RISK_VALUE. Short qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.

Supported API: true

Specified by:

setRiskValue in interface ExecutionObject

Parameters:

a_RiskValue -

See Also:

ProjectRiskValue

getStatusDescription

public String getStatusDescription()

Gets the value of the attribute: STATUS_DESCRIPTION. Textual descriptionof confidence of completing successfully the task or work represented by the execution object.

Supported API: true

Specified by:

getStatusDescription in interface ExecutionObject

Returns:

String

setStatusDescription

public void setStatusDescription(String a_StatusDescription)

Sets the value of the attribute: STATUS_DESCRIPTION. Textual descriptionof confidence of completing successfully the task or work represented by the execution object.

Supported API: true

Specified by:

setStatusDescription in interface ExecutionObject

Parameters:

a_StatusDescription -

getTotalWork

public Work getTotalWork()

Gets the value of the attribute: TOTAL_WORK. Total work associated with a given project management object. Related to performedWork and percentComplete by the formulas:

 performedWork <= totalWork
 percentComplete = (performedWork / totalWork) * 100
 

Supported API: true

Specified by:

getTotalWork in interface ExecutionObject

Returns:

Work

setTotalWork

public void setTotalWork(Work a_TotalWork)

Sets the value of the attribute: TOTAL_WORK. Total work associated with a given project management object. Related to performedWork and percentComplete by the formulas:

 performedWork <= totalWork
 percentComplete = (performedWork / totalWork) * 100
 

Supported API: true

Specified by:

setTotalWork in interface ExecutionObject

Parameters:

a_TotalWork -

getTotalWorkCost

public Currency getTotalWorkCost()

Gets the value of the attribute: TOTAL_WORK_COST.

Supported API: true

Specified by:

getTotalWorkCost in interface ExecutionObject

Returns:

Currency

setTotalWorkCost

public void setTotalWorkCost(Currency a_TotalWorkCost)

Sets the value of the attribute: TOTAL_WORK_COST.

Supported API: true

Specified by:

setTotalWorkCost in interface ExecutionObject

Parameters:

a_TotalWorkCost -

changeState

public ExecutionObject changeState(ProjectState new_state)
                            throws WTException

Changes the state of the execution object to the workflow state that corresponds to the project state passed as argument.

Supported API: false

Specified by:

changeState in interface ExecutionObject

Parameters:

new_state -

Returns:

ExecutionObject

Throws:

WTException

getContainedNodes

public QueryResult getContainedNodes()

Returns object's ContainedNodes (calculated cached value)

Supported API: false

Specified by:

getContainedNodes in interface ExecutionObject

Returns:

QueryResult

getCurrentCost

public Double getCurrentCost()

Returns object's current cost. (calculated cached value)

Supported API: false

Specified by:

getCurrentCost in interface ExecutionObject

Returns:

Double

getDeadline

public Timestamp getDeadline()

Returns object's deadline.

Supported API: false

Specified by:

getDeadline in interface ExecutionObject

Overrides:

getDeadline in class WfExecutionObject

Returns:

Timestamp

getDescription

public String getDescription()

Returns object description.

Supported API: false

Specified by:

getDescription in interface ExecutionObject

Overrides:

getDescription in class WfExecutionObject

Returns:

String

getDuration

public TimeToElapse getDuration()
                         throws WTException

Returns object's Duration. (calculated cached value)

Supported API: false

Specified by:

getDuration in interface ExecutionObject

Returns:

TimeToElapse

Throws:

WTException

getEndTime

public Timestamp getEndTime()

Returns time execution of object finished. Returns 'null' if execution hasn't finished yet.

Supported API: false

Specified by:

getEndTime in interface ExecutionObject

Overrides:

getEndTime in class WfExecutionObject

Returns:

Timestamp

getEstimatedFinish

public Timestamp getEstimatedFinish()

Returns object's estimated finish. (calculated cached value)

Supported API: false

Specified by:

getEstimatedFinish in interface ExecutionObject

Returns:

Timestamp

getExecutionState

public ProjectState getExecutionState()

Returns project execution state that corresponds to internal object's workflow state.

Supported API: false

Specified by:

getExecutionState in interface ExecutionObject

Returns:

ProjectState

getFinishDate

public Timestamp getFinishDate(TimeToElapse days)
                        throws WTException

Returns estimated finish date for the object given the duration given in TimeToElapse. Takes into account the calendar and the start time. Returns null if object hasn't started yet.

Supported API: false

Specified by:

getFinishDate in interface ExecutionObject

Parameters:

days -

Returns:

Timestamp

Throws:

WTException

getName

public String getName()

Returns name of the object.

Supported API: false

Specified by:

getName in interface ExecutionObject

Overrides:

getName in class WfExecutionObject

Returns:

String

getPredecessors

public QueryResult getPredecessors()

Returns object's Predecessors (calculated cached value)

Supported API: false

Specified by:

getPredecessors in interface ExecutionObject

Returns:

QueryResult

getStartTime

public Timestamp getStartTime()

Returns time execution of object started. Returns 'null' if execution hasn't started yet.

Supported API: false

Specified by:

getStartTime in interface ExecutionObject

Overrides:

getStartTime in class WfExecutionObject

Returns:

Timestamp

getSuccessors

public QueryResult getSuccessors()

Returns object's successors. (calculated cached value)

Supported API: false

Specified by:

getSuccessors in interface ExecutionObject

Returns:

QueryResult

getTemplateObject

public WfTemplateObject getTemplateObject()
                                   throws WTException

Returns template to which the execution object is associated.

Supported API: false

Specified by:

getTemplateObject in interface ExecutionObject

Returns:

WfTemplateObject

Throws:

WTException

getTotalCost

public Double getTotalCost()

Returns object's total cost. (calculated cached value)

Supported API: false

Specified by:

getTotalCost in interface ExecutionObject

Returns:

Double

setContainedNodes

public void setContainedNodes(QueryResult a_result)

sets object's ContainedNodes (calculated cached value)

Supported API: false

Specified by:

setContainedNodes in interface ExecutionObject

Parameters:

a_result -

setCurrentCost

public void setCurrentCost(Double cost)

set object's current cost. (calculated cached value)

Supported API: false

Specified by:

setCurrentCost in interface ExecutionObject

Parameters:

cost -

setDeadline

public void setDeadline(Timestamp time)

Sets object's deadline.

Supported API: false

Specified by:

setDeadline in interface ExecutionObject

Overrides:

setDeadline in class WfExecutionObject

Parameters:

time -

setDescription

public void setDescription(String desc)

Sets object description.

Supported API: false

Specified by:

setDescription in interface ExecutionObject

Overrides:

setDescription in class WfExecutionObject

Parameters:

desc -

setDuration

public void setDuration(TimeToElapse a_time)

set object's Duration. (calculated cached value)

Supported API: false

Specified by:

setDuration in interface ExecutionObject

Parameters:

a_time -

setEndTime

public void setEndTime(Timestamp time)

Sets the time the execution of object finished.

Supported API: false

Specified by:

setEndTime in interface ExecutionObject

Overrides:

setEndTime in class WfExecutionObject

Parameters:

time -

setEstimatedFinish

public void setEstimatedFinish(Timestamp a_time)

set object's estimated finish. (calculated cached value)

Supported API: false

Specified by:

setEstimatedFinish in interface ExecutionObject

Parameters:

a_time -

setExecutionState

public void setExecutionState(ProjectState state)

Setsinternal object's workflow state that corresponds to project execution state passed as argument.

Supported API: false

Specified by:

setExecutionState in interface ExecutionObject

Parameters:

state -

setName

public void setName(String name)

Sets name of the object.

Supported API: false

Specified by:

setName in interface ExecutionObject

Overrides:

setName in class WfExecutionObject

Parameters:

name -

setPredecessors

public void setPredecessors(QueryResult a_result)

sets object's Predecessors (calculated cached value)

Supported API: false

Specified by:

setPredecessors in interface ExecutionObject

Parameters:

a_result -

setStartTime

public void setStartTime(Timestamp time)

Sets the s time execution of object started.

Supported API: false

Specified by:

setStartTime in interface ExecutionObject

Overrides:

setStartTime in class WfExecutionObject

Parameters:

time -

setSuccessors

public void setSuccessors(QueryResult a_result)

sets object's successors. (calculated cached value)

Supported API: false

Specified by:

setSuccessors in interface ExecutionObject

Parameters:

a_result -

setTotalCost

public void setTotalCost(Double cost)

set object's total cost. (calculated cached value)

Supported API: false

Specified by:

setTotalCost in interface ExecutionObject

Parameters:

cost -

updateDeadline

public void updateDeadline(Timestamp start)

Supported API: false

Specified by:

updateDeadline in interface ExecutionObject

Parameters:

start -

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

getIndexerSet

public IndexerSet getIndexerSet()

Gets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

getIndexerSet in interface Indexable

Returns:

IndexerSet

setIndexerSet

public void setIndexerSet(IndexerSet a_IndexerSet)

Sets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

setIndexerSet in interface Indexable

Parameters:

a_IndexerSet -

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 WfActivity

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 WfActivity

Returns:

int

initialize

protected void initialize(WfContainer container)
                   throws WTException

Description copied from class: WfActivity

Supported API: false

Overrides:

initialize in class WfActivity

Parameters:

container -

Throws:

WTException

allDeliverablesClosed

private boolean allDeliverablesClosed()
                               throws WTException

Throws:

WTException