wt.projmgmt.resource
Class Deliverable

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.projmgmt.resource.Deliverable

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, ExecutionObject, Externalizable, Indexable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, SubjectOfNotebook, WTContained

public class Deliverable

extends Item

implements ExecutionObject, Externalizable

The Deliverable class represents expected output objects from the plan or activities. A deliverable points to an information resource that contains a reference to a Windchill object.

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

InformationResource, Serialized Form

Field Summary

private TimeToElapse	afterDeadline
static String	ATTR_VALUE_MAP Label for the attribute; Deliverable target configuration: list of name/value pairs, where value must be also a String).
private static int	ATTR_VALUE_MAP_UPPER_LIMIT
private WTStringMap	attrValueMap
private TimeToElapse	beforeDeadline
private static String	CLASSNAME
private ExecutionConfiguration	configuration
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private Currency	currentWorkCost
private Timestamp	deadline
static String	DEADLINE Label for the attribute; Time by which the deliverable should be completed.
private String	description
static String	DESCRIPTION Label for the attribute; Deliverable's description.
private static int	DESCRIPTION_UPPER_LIMIT
private TimeToElapse	duration
static String	DURATION Label for the attribute.
private boolean	enabled
static String	END_TIME Label for the attribute; Time in which work finished being done in the deliverable.
private Timestamp	endTime
private Timestamp	estimatedFinishDate
static String	EVENT_LIST Label for the attribute; List of events that trigger a checking of whether the resource reached the target configuration.
private static int	EVENT_LIST_UPPER_LIMIT
private WTStringSet	eventList
private WTStringSet	eventSet
static String	EXECUTION_STATE Label for the attribute; Project execution state.
private static int	EXECUTION_STATE_UPPER_LIMIT
private ProjectState	executionState
static long	EXTERNALIZATION_VERSION_UID
private static int	HEALTH_STATUS_UPPER_LIMIT
private ProjectHealthStatus	healthStatus
private IndexerSet	indexerSet
private Timestamp	inheritedDeadline
private ProjectActivity	linkedActivity
private String	name
static String	NAME Label for the attribute; Deliverable's name.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private int	percentComplete
private Work	performedWork
static String	PLAN Label for the attribute.
static String	PLAN_REFERENCE Label for the attribute.
private ObjectReference	planReference
private static int	PROJECT_CATEGORY_UPPER_LIMIT
static String	PROJECT_DELIVERABLE Label for the attribute; Tells whether a deliverable is a "project deliverable." A project deliverable is a deliverable that isone of the project goals.
private ProjectCategory	projectCategory
private boolean	projectDeliverable
static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
static String	RESOURCE_REF Label for the attribute; Reference to an information resource that describes the deliverable.
private ObjectReference	resourceRef
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
static String	START_TIME Label for the attribute; Time in which work started being done in the deliverable.
private Timestamp	startTime
private static int	STATUS_DESCRIPTION_UPPER_LIMIT
private String	statusDescription
static String	TARGET_CONFIGURATION Label for the attribute; Description of the state or configuration the resource must be in order for the deliverable to be considered satisfied.
private static int	TARGET_CONFIGURATION_UPPER_LIMIT
private String	targetConfiguration
private Work	totalWork
private Currency	totalWorkCost
private static boolean	VERBOSE

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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_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.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

Deliverable()

Method Summary

private void	attrValueMapValidate(WTStringMap a_AttrValueMap)
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.
private void	checkValidRestart() Throws an exception if it is not valid to restart deliverable.
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	eventListValidate(WTStringSet a_EventList)
TimeToElapse	getAfterDeadline() Gets the value of the attribute: AFTER_DEADLINE.
WTStringMap	getAttrValueMap() Gets the value of the attribute: ATTR_VALUE_MAP.
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
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
Double	getCurrentCost() Returns object's current cost.
Currency	getCurrentWorkCost() Gets the value of the attribute: CURRENT_WORK_COST.
Timestamp	getDeadline() Gets the value of the attribute: DEADLINE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
TimeToElapse	getDuration() Gets the value of the attribute: DURATION.
TimeToElapse	getDuration1() Returns deliverable's duration.
Timestamp	getEndTime() Gets the value of the attribute: END_TIME.
Timestamp	getEstimatedFinish() Returns object's estimated finish.
Timestamp	getEstimatedFinishDate() Gets the value of the attribute: ESTIMATED_FINISH_DATE.
WTStringSet	getEventList() Gets the value of the attribute: EVENT_LIST.
WTStringSet	getEventSet() Gets the value of the attribute: EVENT_SET.
ProjectState	getExecutionState() Gets the value of the attribute: EXECUTION_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.
private ObjectIdentifier	getId(Object obj)
IndexerSet	getIndexerSet() Gets the value of the attribute: INDEXER_SET.
Timestamp	getInheritedDeadline() Gets the value of the attribute: INHERITED_DEADLINE.
Timestamp	getInitialTime()
ProjectActivity	getLinkedActivity() Returns the ProjectActivity linked to the deliverable.
String	getName() Gets the value of the attribute: NAME.
Timestamp	getNewFinish(Timestamp new_start, Timestamp old_start) Gets a new estimatedFinishDate given the new and old start dates.
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.
ObjectReference	getResourceRef() Gets the value of the attribute: RESOURCE_REF.
String	getRiskDescription() Gets the value of the attribute: RISK_DESCRIPTION.
ProjectRiskValue	getRiskValue() Gets the value of the attribute: RISK_VALUE.
Timestamp	getStartTime() Gets the value of the attribute: START_TIME.
State	getState() Returns the lifecycle state of the object that is referred to by the information resource of the deliverable.
String	getStatusDescription() Gets the value of the attribute: STATUS_DESCRIPTION.
QueryResult	getSuccessors() Returns object's successors.
Persistable	getTarget() Returns the the object that is referred to by the information resource of the deliverable.
String	getTargetConfiguration() Gets the value of the attribute: TARGET_CONFIGURATION.
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(ProjectPlan plan) Supports initialization, following construction of an instance.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isProjectDeliverable() Gets the value of the attribute: PROJECT_DELIVERABLE.
static Deliverable	newDeliverable(ProjectPlan plan) Deliverable 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(Deliverable thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	resourceRefValidate(ObjectReference a_ResourceRef)
void	setAfterDeadline(TimeToElapse a_AfterDeadline) Sets the value of the attribute: AFTER_DEADLINE.
void	setAttrValueMap(WTStringMap a_AttrValueMap) Sets the value of the attribute: ATTR_VALUE_MAP.
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	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
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 a_Deadline) Sets the value of the attribute: DEADLINE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setDuration(TimeToElapse a_Duration) Sets the value of the attribute: DURATION.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setEndTime(Timestamp a_EndTime) Sets the value of the attribute: END_TIME.
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	setEventList(WTStringSet a_EventList) Sets the value of the attribute: EVENT_LIST.
void	setEventSet(WTStringSet a_EventSet) Sets the value of the attribute: EVENT_SET.
void	setExecutionState(ProjectState a_ExecutionState) Sets the value of the attribute: EXECUTION_STATE.
void	setHealthStatus(ProjectHealthStatus a_HealthStatus) Sets the value of the attribute: HEALTH_STATUS.
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 a_Name) Sets the value of the attribute: NAME.
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	setProjectDeliverable(boolean a_ProjectDeliverable) Sets the value of the attribute: PROJECT_DELIVERABLE.
void	setResourceRef(ObjectReference a_ResourceRef) Sets the value of the attribute: RESOURCE_REF.
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 a_StartTime) Sets the value of the attribute: START_TIME.
void	setState(State state) Sets the lifecycle state of the object that is referred to by the information resource of the deliverable.
void	setStatusDescription(String a_StatusDescription) Sets the value of the attribute: STATUS_DESCRIPTION.
void	setSuccessors(QueryResult a_result) sets object's successors.
void	setTargetConfiguration(String a_TargetConfiguration) Sets the value of the attribute: TARGET_CONFIGURATION.
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.
private void	targetConfigurationValidate(String a_TargetConfiguration)
String	toString() Produces string representation of the object.
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.fc.Item

getDomainRef, initialize, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, 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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

ATTR_VALUE_MAP

public static final String ATTR_VALUE_MAP

Label for the attribute; Deliverable target configuration: list of name/value pairs, where value must be also a String). "Name" stands for attribute name and "value" stands for attribute value. The configuration is considered to be satisfied for an object when the object contains all attributes in the list and their values match the corresponding map values.

Supported API: false

See Also:

WTStringMap, WTStringMap, Constant Field Values

ATTR_VALUE_MAP_UPPER_LIMIT

private static int ATTR_VALUE_MAP_UPPER_LIMIT

attrValueMap

private WTStringMap attrValueMap

DEADLINE

public static final String DEADLINE

Label for the attribute; Time by which the deliverable should be completed.

Supported API: false

See Also:

Constant Field Values

deadline

private Timestamp deadline

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Deliverable's description. Longer but still human readable identification of the object.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

DURATION

public static final String DURATION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

duration

private TimeToElapse duration

END_TIME

public static final String END_TIME

Label for the attribute; Time in which work finished being done in the deliverable.

Supported API: false

See Also:

Constant Field Values

endTime

private Timestamp endTime

EVENT_LIST

public static final String EVENT_LIST

Label for the attribute; List of events that trigger a checking of whether the resource reached the target configuration. Typically these events are modify, check in and change state.

Supported API: false

See Also:

WTStringSet, Constant Field Values

EVENT_LIST_UPPER_LIMIT

private static int EVENT_LIST_UPPER_LIMIT

eventList

private WTStringSet eventList

EXECUTION_STATE

public static final String EXECUTION_STATE

Label for the attribute; Project execution state.

Supported API: false

See Also:

ProjectState, Constant Field Values

EXECUTION_STATE_UPPER_LIMIT

private static int EXECUTION_STATE_UPPER_LIMIT

executionState

private ProjectState executionState

NAME

public static final String NAME

Label for the attribute; Deliverable's name. Short, human readable identification of the object.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

PROJECT_DELIVERABLE

public static final String PROJECT_DELIVERABLE

Label for the attribute; Tells whether a deliverable is a "project deliverable." A project deliverable is a deliverable that isone of the project goals. A project deliverable is usually also a milestonne deliverable but this is not necessarily so.

See Also:

Constant Field Values

projectDeliverable

private boolean projectDeliverable

RESOURCE_REF

public static final String RESOURCE_REF

Label for the attribute; Reference to an information resource that describes the deliverable.

Supported API: false

See Also:

Constant Field Values

resourceRef

private ObjectReference resourceRef

START_TIME

public static final String START_TIME

Label for the attribute; Time in which work started being done in the deliverable.

Supported API: false

See Also:

Constant Field Values

startTime

private Timestamp startTime

TARGET_CONFIGURATION

public static final String TARGET_CONFIGURATION

Label for the attribute; Description of the state or configuration the resource must be in order for the deliverable to be considered satisfied.

Supported API: false

See Also:

Constant Field Values

TARGET_CONFIGURATION_UPPER_LIMIT

private static int TARGET_CONFIGURATION_UPPER_LIMIT

targetConfiguration

private String targetConfiguration

PLAN

public static final String PLAN

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PLAN_REFERENCE

public static final String PLAN_REFERENCE

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

eventSet

private WTStringSet eventSet

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

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

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

linkedActivity

private ProjectActivity linkedActivity

Constructor Detail

Deliverable

public Deliverable()

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 Item

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 Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Deliverable 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 Item

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 Item

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

getAttrValueMap

public WTStringMap getAttrValueMap()

Gets the value of the attribute: ATTR_VALUE_MAP. Deliverable target configuration: list of name/value pairs, where value must be also a String). "Name" stands for attribute name and "value" stands for attribute value. The configuration is considered to be satisfied for an object when the object contains all attributes in the list and their values match the corresponding map values.

Supported API: false

Returns:

WTStringMap

See Also:

WTStringMap, WTStringMap

setAttrValueMap

public void setAttrValueMap(WTStringMap a_AttrValueMap)
                     throws WTPropertyVetoException

Sets the value of the attribute: ATTR_VALUE_MAP. Deliverable target configuration: list of name/value pairs, where value must be also a String). "Name" stands for attribute name and "value" stands for attribute value. The configuration is considered to be satisfied for an object when the object contains all attributes in the list and their values match the corresponding map values.

Supported API: false

Parameters:

a_AttrValueMap -

Throws:

WTPropertyVetoException

See Also:

WTStringMap, WTStringMap

attrValueMapValidate

private void attrValueMapValidate(WTStringMap a_AttrValueMap)
                           throws WTPropertyVetoException

Parameters:

a_AttrValueMap -

Throws:

WTPropertyVetoException

getDeadline

public Timestamp getDeadline()

Gets the value of the attribute: DEADLINE. Time by which the deliverable should be completed.

Supported API: false

Specified by:

getDeadline in interface ExecutionObject

Returns:

Timestamp

setDeadline

public void setDeadline(Timestamp a_Deadline)

Sets the value of the attribute: DEADLINE. Time by which the deliverable should be completed.

Supported API: false

Specified by:

setDeadline in interface ExecutionObject

Parameters:

a_Deadline -

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Deliverable's description. Longer but still human readable identification of the object.

Supported API: false

Specified by:

getDescription in interface ExecutionObject

Returns:

String

setDescription

public void setDescription(String a_Description)

Sets the value of the attribute: DESCRIPTION. Deliverable's description. Longer but still human readable identification of the object.

Supported API: false

Specified by:

setDescription in interface ExecutionObject

Parameters:

a_Description -

getDuration

public TimeToElapse getDuration()

Gets the value of the attribute: DURATION.

Supported API: false

Specified by:

getDuration in interface ExecutionObject

Returns:

TimeToElapse

setDuration

public void setDuration(TimeToElapse a_Duration)

Sets the value of the attribute: DURATION.

Supported API: false

Specified by:

setDuration in interface ExecutionObject

Parameters:

a_Duration -

getEndTime

public Timestamp getEndTime()

Gets the value of the attribute: END_TIME. Time in which work finished being done in the deliverable.

Supported API: false

Specified by:

getEndTime in interface ExecutionObject

Returns:

Timestamp

setEndTime

public void setEndTime(Timestamp a_EndTime)

Sets the value of the attribute: END_TIME. Time in which work finished being done in the deliverable.

Supported API: false

Specified by:

setEndTime in interface ExecutionObject

Parameters:

a_EndTime -

getEventList

public WTStringSet getEventList()

Gets the value of the attribute: EVENT_LIST. List of events that trigger a checking of whether the resource reached the target configuration. Typically these events are modify, check in and change state.

Supported API: false

Returns:

WTStringSet

See Also:

WTStringSet

setEventList

public void setEventList(WTStringSet a_EventList)
                  throws WTPropertyVetoException

Sets the value of the attribute: EVENT_LIST. List of events that trigger a checking of whether the resource reached the target configuration. Typically these events are modify, check in and change state.

Supported API: false

Parameters:

a_EventList -

Throws:

WTPropertyVetoException

See Also:

WTStringSet

eventListValidate

private void eventListValidate(WTStringSet a_EventList)
                        throws WTPropertyVetoException

Parameters:

a_EventList -

Throws:

WTPropertyVetoException

getExecutionState

public ProjectState getExecutionState()

Gets the value of the attribute: EXECUTION_STATE. Project execution state.

Supported API: false

Specified by:

getExecutionState in interface ExecutionObject

Returns:

ProjectState

See Also:

ProjectState

setExecutionState

public void setExecutionState(ProjectState a_ExecutionState)

Sets the value of the attribute: EXECUTION_STATE. Project execution state.

Supported API: false

Specified by:

setExecutionState in interface ExecutionObject

Parameters:

a_ExecutionState -

See Also:

ProjectState

getName

public String getName()

Gets the value of the attribute: NAME. Deliverable's name. Short, human readable identification of the object.

Supported API: false

Specified by:

getName in interface ExecutionObject

Returns:

String

setName

public void setName(String a_Name)

Sets the value of the attribute: NAME. Deliverable's name. Short, human readable identification of the object.

Supported API: false

Specified by:

setName in interface ExecutionObject

Parameters:

a_Name -

isProjectDeliverable

public boolean isProjectDeliverable()

Gets the value of the attribute: PROJECT_DELIVERABLE. Tells whether a deliverable is a "project deliverable." A project deliverable is a deliverable that isone of the project goals. A project deliverable is usually also a milestonne deliverable but this is not necessarily so.

Returns:

boolean

setProjectDeliverable

public void setProjectDeliverable(boolean a_ProjectDeliverable)

Sets the value of the attribute: PROJECT_DELIVERABLE. Tells whether a deliverable is a "project deliverable." A project deliverable is a deliverable that isone of the project goals. A project deliverable is usually also a milestonne deliverable but this is not necessarily so.

Parameters:

a_ProjectDeliverable -

getResourceRef

public ObjectReference getResourceRef()

Gets the value of the attribute: RESOURCE_REF. Reference to an information resource that describes the deliverable.

Supported API: false

Returns:

ObjectReference

setResourceRef

public void setResourceRef(ObjectReference a_ResourceRef)
                    throws WTPropertyVetoException

Sets the value of the attribute: RESOURCE_REF. Reference to an information resource that describes the deliverable.

Supported API: false

Parameters:

a_ResourceRef -

Throws:

WTPropertyVetoException

resourceRefValidate

private void resourceRefValidate(ObjectReference a_ResourceRef)
                          throws WTPropertyVetoException

Parameters:

a_ResourceRef -

Throws:

WTPropertyVetoException

getStartTime

public Timestamp getStartTime()

Gets the value of the attribute: START_TIME. Time in which work started being done in the deliverable.

Supported API: false

Specified by:

getStartTime in interface ExecutionObject

Returns:

Timestamp

setStartTime

public void setStartTime(Timestamp a_StartTime)

Sets the value of the attribute: START_TIME. Time in which work started being done in the deliverable.

Supported API: false

Specified by:

setStartTime in interface ExecutionObject

Parameters:

a_StartTime -

getTargetConfiguration

public String getTargetConfiguration()

Gets the value of the attribute: TARGET_CONFIGURATION. Description of the state or configuration the resource must be in order for the deliverable to be considered satisfied.

Supported API: false

Returns:

String

setTargetConfiguration

public void setTargetConfiguration(String a_TargetConfiguration)
                            throws WTPropertyVetoException

Sets the value of the attribute: TARGET_CONFIGURATION. Description of the state or configuration the resource must be in order for the deliverable to be considered satisfied.

Supported API: false

Parameters:

a_TargetConfiguration -

Throws:

WTPropertyVetoException

targetConfigurationValidate

private void targetConfigurationValidate(String a_TargetConfiguration)
                                  throws WTPropertyVetoException

Parameters:

a_TargetConfiguration -

Throws:

WTPropertyVetoException

getPlan

public ProjectPlan getPlan()

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

Supported API: false

Specified by:

getPlan in interface ExecutionObject

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

Parameters:

a_Plan -

Throws:

WTPropertyVetoException

WTException

getPlanReference

public ObjectReference getPlanReference()

Gets the value of the attribute: PLAN_REFERENCE.

Supported API: false

Returns:

ObjectReference

setPlanReference

public void setPlanReference(ObjectReference a_PlanReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: PLAN_REFERENCE.

Supported API: false

Parameters:

a_PlanReference -

Throws:

WTPropertyVetoException

planReferenceValidate

private void planReferenceValidate(ObjectReference a_PlanReference)
                            throws WTPropertyVetoException

Parameters:

a_PlanReference -

Throws:

WTPropertyVetoException

newDeliverable

public static Deliverable newDeliverable(ProjectPlan plan)
                                  throws WTException

Deliverable constructor. The host project plan is passed as an argument.

Supported API: false

Parameters:

plan -

Returns:

Deliverable

Throws:

WTException

See Also:

ProjectPlan

initialize

protected void initialize(ProjectPlan plan)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

plan -

Throws:

WTException

getLinkedActivity

public ProjectActivity getLinkedActivity()
                                  throws WTException

Returns the ProjectActivity linked to the deliverable. This activity is not null if the "link deliverables" option is selected and the deliverable has been linked to an activity.

Supported API: false

Returns:

ProjectActivity

Throws:

WTException

getNewFinish

public Timestamp getNewFinish(Timestamp new_start,
                              Timestamp old_start)
                       throws WTException

Gets a new estimatedFinishDate given the new and old start dates.

The old start date is used to compute the duration, which is then used with the new start to compute the new estimated finish date.

Supported API: false

Parameters:

new_start -

old_start -

Returns:

Timestamp

Throws:

WTException

getState

public State getState()

Returns the lifecycle state of the object that is referred to by the information resource of the deliverable. Returns 'null' if there is no object or if it is not LifeCycleManaged.

Supported API: false

Returns:

State

See Also:

State

getTarget

public Persistable getTarget()
                      throws WTException

Returns the the object that is referred to by the information resource of the deliverable. Returns 'null' if there is no object.

Setting the target is done through the 'setTarget' method of the resource service.

Supported API: false

Returns:

Persistable

Throws:

WTException

See Also:

ProjResourceService

setState

public void setState(State state)
              throws WTException

Sets the lifecycle state of the object that is referred to by the information resource of the deliverable. Does nothing if there is no object or if it is not LifeCycleManaged.

Supported API: false

Parameters:

state -

Throws:

WTException

See Also:

State

toString

public String toString()

Produces string representation of the object.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

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

getEstimatedFinish

public Timestamp getEstimatedFinish()

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

Supported API: false

Specified by:

getEstimatedFinish in interface ExecutionObject

Returns:

Timestamp

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

getPredecessors

public QueryResult getPredecessors()

Returns object's Predecessors (calculated cached value)

Supported API: false

Specified by:

getPredecessors in interface ExecutionObject

Returns:

QueryResult

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 -

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 -

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 -

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 -

getEventSet

public WTStringSet getEventSet()

Gets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

getEventSet in interface Notifiable

Returns:

WTStringSet

setEventSet

public void setEventSet(WTStringSet a_EventSet)

Sets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

setEventSet in interface Notifiable

Parameters:

a_EventSet -

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

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 Item

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 Item

Returns:

int

getInitialTime

public Timestamp getInitialTime()
                         throws WTException

Throws:

WTException

getId

private ObjectIdentifier getId(Object obj)

checkValidRestart

private void checkValidRestart()
                        throws WTException

Throws an exception if it is not valid to restart deliverable. A deliverable can be restarted provided the two following conditions are satisfied:

• The change is being made by project manager.
• No holder has been completed. The holders are the activity/project and the milestones.

Throws:

WTException

getDuration1

public TimeToElapse getDuration1()
                          throws WTException

Returns deliverable's duration. This duration is computed as the difference between the estimated finish time and the start time if deliverable has started or the creation time if not. Returns 'null' if estimated finish date is null.

Supported API: false

Returns:

TimeToElapse

Throws:

WTException