wt.projmgmt.execution
Class ProjectPlan

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.engine.WfExecutionObject
              wt.workflow.engine.WfContainer
                  wt.workflow.engine.WfProcess
                      wt.projmgmt.execution.ProjectPlan

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, ContentHolder, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Indexable, WTContained, Notifiable, Ownable, wt.project.RoleHolder, ExecutionObject, wt.projmgmt.resource.ResourceHolder, wt.recent.RecentlyVisited, wt.team.TeamManaged, wt.workflow.forum.SubjectOfForum, wt.workflow.notebook.SubjectOfNotebook

public class ProjectPlan
extends WfProcess
implements ExecutionObject, wt.projmgmt.resource.ResourceHolder, Externalizable

The ProjectPlan class represents a container for activities, resources, deliverables and their relationships that are involved in the execution of a project.

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

ProjectActivity, SummaryActivity, Deliverable, ProjectResource, Serialized Form

Field Summary

static String	PHASE Label for the attribute; Description of project's stage in its execution.
static String	SCOPE Label for the attribute; Description of project's scope.

Fields inherited from class wt.workflow.engine.WfProcess

CREATOR

Fields inherited from class wt.workflow.engine.WfExecutionObject

CONTEXT, NAME, PRIORITY

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.
ProjectPhase	getPhase() Gets the value of the attribute: PHASE.
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	getScope() Gets the value of the attribute: SCOPE.
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	setPhase(ProjectPhase a_Phase) Sets the value of the attribute: PHASE.
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	setScope(String a_Scope) Sets the value of the attribute: SCOPE.
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.workflow.engine.WfProcess

getCreator, setCreator

Methods inherited from class wt.workflow.engine.WfExecutionObject

getPriority, setContext, setPriority

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

Field Detail

PHASE

public static final String PHASE

Label for the attribute; Description of project's stage in its execution. If the project plan is associated with a Project2 object this attribute is ignored, otherwise it can be set and retrieved using the attribute's accessors.

Supported API: true

See Also:

ProjectPhase, Project2, Constant Field Values

SCOPE

public static final String SCOPE

Label for the attribute; Description of project's scope. If the project plan is associated with a Project2 object this attribute is ignored, otherwise it can be set and retrieved using the attribute's accessors.

Supported API: true

See Also:

Project2, Constant Field Values

Method Detail

getPhase

public ProjectPhase getPhase()

Gets the value of the attribute: PHASE. Description of project's stage in its execution. If the project plan is associated with a Project2 object this attribute is ignored, otherwise it can be set and retrieved using the attribute's accessors.

Supported API: true

Returns:

ProjectPhase

See Also:

ProjectPhase, Project2

setPhase

public void setPhase(ProjectPhase a_Phase)
              throws WTPropertyVetoException

Sets the value of the attribute: PHASE. Description of project's stage in its execution. If the project plan is associated with a Project2 object this attribute is ignored, otherwise it can be set and retrieved using the attribute's accessors.

Supported API: true

Parameters:

a_Phase -

Throws:

WTPropertyVetoException

See Also:

ProjectPhase, Project2

getScope

public String getScope()

Gets the value of the attribute: SCOPE. Description of project's scope. If the project plan is associated with a Project2 object this attribute is ignored, otherwise it can be set and retrieved using the attribute's accessors.

Supported API: true

Returns:

String

See Also:

Project2

setScope

public void setScope(String a_Scope)
              throws WTPropertyVetoException

Sets the value of the attribute: SCOPE. Description of project's scope. If the project plan is associated with a Project2 object this attribute is ignored, otherwise it can be set and retrieved using the attribute's accessors.

Supported API: true

Parameters:

a_Scope -

Throws:

WTPropertyVetoException

See Also:

Project2

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 -