wt.projmgmt.execution
Class ProjectWorkItem

java.lang.Object
  extended by wt.fc.WTObject
      extended by wt.workflow.work.WorkItem
          extended by wt.projmgmt.execution.ProjectWorkItem
All Implemented Interfaces:
Externalizable, Serializable, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Indexable, WTContained, Notifiable, Ownable, ExecutionObject, wt.projmgmt.resource.ResourceHolder, wt.recent.RecentlyVisited, wt.workflow.notebook.SubjectOfNotebook

public class ProjectWorkItem
extends wt.workflow.work.WorkItem
implements ExecutionObject, wt.admin.DomainAdministered, wt.projmgmt.resource.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
 
Fields inherited from interface wt.projmgmt.execution.ExecutionObject
CURRENT_WORK_COST, ESTIMATED_FINISH_DATE, HEALTH_STATUS, INHERITED_DEADLINE, PERCENT_COMPLETE, PERFORMED_WORK, PROJECT_CATEGORY, RISK_DESCRIPTION, RISK_VALUE, STATUS_DESCRIPTION, TOTAL_WORK, TOTAL_WORK_COST
 
Method Summary
 Currency getCurrentWorkCost()
          Gets the value of the attribute: CURRENT_WORK_COST.
 Timestamp getEstimatedFinishDate()
          Gets the value of the attribute: ESTIMATED_FINISH_DATE.
 ProjectHealthStatus getHealthStatus()
          Gets the value of the attribute: HEALTH_STATUS.
 Timestamp getInheritedDeadline()
          Gets the value of the attribute: INHERITED_DEADLINE.
 int getPercentComplete()
          Gets the value of the attribute: PERCENT_COMPLETE.
 wt.projmgmt.resource.Work getPerformedWork()
          Gets the value of the attribute: PERFORMED_WORK.
 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.
 String getStatusDescription()
          Gets the value of the attribute: STATUS_DESCRIPTION.
 wt.projmgmt.resource.Work getTotalWork()
          Gets the value of the attribute: TOTAL_WORK.
 Currency getTotalWorkCost()
          Gets the value of the attribute: TOTAL_WORK_COST.
 void setCurrentWorkCost(Currency a_CurrentWorkCost)
          Sets the value of the attribute: CURRENT_WORK_COST.
 void setEstimatedFinishDate(Timestamp a_EstimatedFinishDate)
          Sets the value of the attribute: ESTIMATED_FINISH_DATE.
 void setHealthStatus(ProjectHealthStatus a_HealthStatus)
          Sets the value of the attribute: HEALTH_STATUS.
 void setInheritedDeadline(Timestamp a_InheritedDeadline)
          Sets the value of the attribute: INHERITED_DEADLINE.
 void setPercentComplete(int a_PercentComplete)
          Sets the value of the attribute: PERCENT_COMPLETE.
 void setPerformedWork(wt.projmgmt.resource.Work a_PerformedWork)
          Sets the value of the attribute: PERFORMED_WORK.
 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 setStatusDescription(String a_StatusDescription)
          Sets the value of the attribute: STATUS_DESCRIPTION.
 void setTotalWork(wt.projmgmt.resource.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.
 
Methods inherited from class wt.fc.WTObject
getDisplayIdentifier, getDisplayIdentity, getDisplayType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

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 -

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 wt.projmgmt.resource.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(wt.projmgmt.resource.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 wt.projmgmt.resource.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(wt.projmgmt.resource.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 -