wt.projmgmt.execution
Class ProjectWorkItem

java.lang.Object
  wt.fc.WTObject
      wt.workflow.work.WorkItem
          wt.projmgmt.execution.ProjectWorkItem

All Implemented Interfaces:

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

public class ProjectWorkItem

extends WorkItem

implements ExecutionObject, DomainAdministered, ResourceHolder, Externalizable

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

Serialized Form

Field Summary

private TimeToElapse	afterDeadline
private TimeToElapse	beforeDeadline
private static String	CLASSNAME
private ExecutionConfiguration	configuration
protected QueryResult	containedNodes
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
protected Double	currentCost
private Currency	currentWorkCost
private AdminDomainRef	domainRef
protected TimeToElapse	duration
private boolean	enabled
protected Timestamp	estimatedFinish
private Timestamp	estimatedFinishDate
private WTStringSet	eventSet
static long	EXTERNALIZATION_VERSION_UID
private static int	HEALTH_STATUS_UPPER_LIMIT
private ProjectHealthStatus	healthStatus
private IndexerSet	indexerSet
private Timestamp	inheritedDeadline
private boolean	inheritedDomain
protected static long	OLD_FORMAT_VERSION_UID
static String	OVERTIME_WORK Label for the attribute; Hour done outside normal working hours.
private Work	overtimeWork
private int	percentComplete
private Work	performedWork
static String	PLAN Label for the attribute.
static String	PLAN_REFERENCE 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
static String	STANDARD_WORK Label for the attribute; Work done during normal hours.
private Work	standardWork
private static int	STATUS_DESCRIPTION_UPPER_LIMIT
private String	statusDescription
protected QueryResult	successors
static String	TOTAL_OVERTIME_WORK Label for the attribute; Total work done outside normal working hours.
static String	TOTAL_STANDARD_WORK Label for the attribute; Total work done during normal hours.
protected Double	totalCost
private Work	totalOvertimeWork
private Work	totalStandardWork
private Work	totalWork
private Currency	totalWorkCost

Fields inherited from class wt.workflow.work.WorkItem

COMPLETED_BY, DELEGATE, DESCRIPTION, PARENT_WA, PRIMARY_BUSINESS_OBJECT, PRIORITY, REASSIGNED, REQUIRED, ROLE, SOURCE, STATUS, TASK_URLPATH_INFO, VARIABLE_PERMISSION_MAP

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

ProjectWorkItem()

Method Summary

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	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.
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
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() Returns object's deadline.
String	getDescription() Returns object description.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
TimeToElapse	getDuration() Returns the number of working days between the creation of the work item and the estimated finish date.
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.
WTStringSet	getEventSet() Gets the value of the attribute: EVENT_SET.
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.
private ObjectIdentifier	getId(Object obj)
private String	getIdString(Object obj)
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.
Work	getOvertimeWork() Gets the value of the attribute: OVERTIME_WORK.
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.
Work	getStandardWork() Gets the value of the attribute: STANDARD_WORK.
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	getTotalOvertimeWork() Gets the value of the attribute: TOTAL_OVERTIME_WORK.
Work	getTotalStandardWork() Gets the value of the attribute: TOTAL_STANDARD_WORK.
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, WTPrincipal owner) Supports initialization, following construction of an instance.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
static ProjectWorkItem	newProjectWorkItem(ProjectPlan plan, WTPrincipal owner) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ProjectWorkItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected ProjectWorkItem	reset() Resets work item attributes to initial value.
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	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 time) Sets object's deadline.
void	setDescription(String desc) Sets object description.
void	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
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	setEventSet(WTStringSet a_EventSet) Sets the value of the attribute: EVENT_SET.
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	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	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setName(String name) Sets name of the object.
void	setOvertimeWork(Work a_OvertimeWork) Sets the value of the attribute: OVERTIME_WORK.
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	setStandardWork(Work a_StandardWork) Sets the value of the attribute: STANDARD_WORK.
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	setTotalOvertimeWork(Work a_TotalOvertimeWork) Sets the value of the attribute: TOTAL_OVERTIME_WORK.
void	setTotalStandardWork(Work a_TotalStandardWork) Sets the value of the attribute: TOTAL_STANDARD_WORK.
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.
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.work.WorkItem

getCompletedBy, getDelegate, getIdentity, getOwnership, getParentWA, getPrimaryBusinessObject, getPriority, getRole, getSource, getStatus, getTaskURLPathInfo, getVariablePermissionMap, initialize, isComplete, isReassigned, isRequired, newWorkItem, newWorkItem, newWorkItem, readVersion, setComplete, setDelegate, setOwnership, setParentWA, setPrimaryBusinessObject, setPriority, setReassigned, setRequired, setRole, setSource, setStatus, setTaskURLPathInfo, setVariablePermissionMap

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

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.ownership.Ownable

getOwnership, setOwnership

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

STANDARD_WORK

public static final String STANDARD_WORK

Label for the attribute; Work done during normal hours. Related to performedWork and standardWork through the equation (invariant):

 performedWork = standardWork + overtimeWork
 

Supported API: false

See Also:

Constant Field Values

standardWork

private Work standardWork

TOTAL_STANDARD_WORK

public static final String TOTAL_STANDARD_WORK

Label for the attribute; Total work done during normal hours. Related to totalWork and totalOvertimeWork through the equation (invariant):

 totalWork = totalStandardWork + totalOvertimeWork
 

Supported API: false

See Also:

Constant Field Values

totalStandardWork

private Work totalStandardWork

OVERTIME_WORK

public static final String OVERTIME_WORK

Label for the attribute; Hour done outside normal working hours. Related to performedWork and standardWork through the equation (invariant):

 performedWork = standardWork + overtimeWork
 

Supported API: false

See Also:

Constant Field Values

overtimeWork

private Work overtimeWork

TOTAL_OVERTIME_WORK

public static final String TOTAL_OVERTIME_WORK

Label for the attribute; Total work done outside normal working hours. Related to totalWork and totalStandardWork through the equation (invariant):

 totalWork = totalStandardWork + totalOvertimeWork
 

Supported API: false

See Also:

Constant Field Values

totalOvertimeWork

private Work totalOvertimeWork

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

indexerSet

private IndexerSet indexerSet

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

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

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

ProjectWorkItem

public ProjectWorkItem()

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 WorkItem

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 WorkItem

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ProjectWorkItem 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 WorkItem

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 WorkItem

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

Overrides:

getConceptualClassname in class WorkItem

Returns:

String

getStandardWork

public Work getStandardWork()

Gets the value of the attribute: STANDARD_WORK. Work done during normal hours. Related to performedWork and standardWork through the equation (invariant):

 performedWork = standardWork + overtimeWork
 

Supported API: false

Returns:

Work

setStandardWork

public void setStandardWork(Work a_StandardWork)

Sets the value of the attribute: STANDARD_WORK. Work done during normal hours. Related to performedWork and standardWork through the equation (invariant):

 performedWork = standardWork + overtimeWork
 

Supported API: false

Parameters:

a_StandardWork -

getTotalStandardWork

public Work getTotalStandardWork()

Gets the value of the attribute: TOTAL_STANDARD_WORK. Total work done during normal hours. Related to totalWork and totalOvertimeWork through the equation (invariant):

 totalWork = totalStandardWork + totalOvertimeWork
 

Supported API: false

Returns:

Work

setTotalStandardWork

public void setTotalStandardWork(Work a_TotalStandardWork)

Sets the value of the attribute: TOTAL_STANDARD_WORK. Total work done during normal hours. Related to totalWork and totalOvertimeWork through the equation (invariant):

 totalWork = totalStandardWork + totalOvertimeWork
 

Supported API: false

Parameters:

a_TotalStandardWork -

getOvertimeWork

public Work getOvertimeWork()

Gets the value of the attribute: OVERTIME_WORK. Hour done outside normal working hours. Related to performedWork and standardWork through the equation (invariant):

 performedWork = standardWork + overtimeWork
 

Supported API: false

Returns:

Work

setOvertimeWork

public void setOvertimeWork(Work a_OvertimeWork)

Sets the value of the attribute: OVERTIME_WORK. Hour done outside normal working hours. Related to performedWork and standardWork through the equation (invariant):

 performedWork = standardWork + overtimeWork
 

Supported API: false

Parameters:

a_OvertimeWork -

getTotalOvertimeWork

public Work getTotalOvertimeWork()

Gets the value of the attribute: TOTAL_OVERTIME_WORK. Total work done outside normal working hours. Related to totalWork and totalStandardWork through the equation (invariant):

 totalWork = totalStandardWork + totalOvertimeWork
 

Supported API: false

Returns:

Work

setTotalOvertimeWork

public void setTotalOvertimeWork(Work a_TotalOvertimeWork)

Sets the value of the attribute: TOTAL_OVERTIME_WORK. Total work done outside normal working hours. Related to totalWork and totalStandardWork through the equation (invariant):

 totalWork = totalStandardWork + totalOvertimeWork
 

Supported API: false

Parameters:

a_TotalOvertimeWork -

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 WTException

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

Supported API: false

Parameters:

a_Plan -

Throws:

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)

Sets the value of the attribute: PLAN_REFERENCE.

Supported API: false

Parameters:

a_PlanReference -

newProjectWorkItem

public static ProjectWorkItem newProjectWorkItem(ProjectPlan plan,
                                                 WTPrincipal owner)
                                          throws WTException

Supported API: false

Parameters:

plan -

owner -

Returns:

ProjectWorkItem

Throws:

WTException

initialize

protected void initialize(ProjectPlan plan,
                          WTPrincipal owner)
                   throws WTException

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

Supported API: false

Parameters:

plan -

owner -

Throws:

WTException

getDuration

public TimeToElapse getDuration()
                         throws WTException

Returns the number of working days between the creation of the work item and the estimated finish date.

Supported API: false

Specified by:

getDuration in interface ExecutionObject

Returns:

TimeToElapse

Throws:

WTException

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

Returns:

Timestamp

getDescription

public String getDescription()

Returns object description.

Supported API: false

Specified by:

getDescription in interface ExecutionObject

Overrides:

getDescription in class WorkItem

Returns:

String

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

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

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

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

Parameters:

time -

setDescription

public void setDescription(String desc)

Sets object description.

Supported API: false

Specified by:

setDescription in interface ExecutionObject

Overrides:

setDescription in class WorkItem

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

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

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

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 -

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

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 -

isInheritedDomain

public boolean isInheritedDomain()

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

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

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

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

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

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 WorkItem

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 WorkItem

Returns:

int

reset

protected ProjectWorkItem reset()
                         throws WTException

Resets work item attributes to initial value. The attributes and values are given in the following table.

 ---------------------------------------------------------------
 Attribute    Initial Value  Obs
 ---------------------------------------------------------------
 completedBy  null           Can't change: WI code prevents it.
 status       POTENTIAL
 ---------------------------------------------------------------
 

Throws:

WTException

getIdString

private String getIdString(Object obj)

getId

private ObjectIdentifier getId(Object obj)