Package wt.projmgmt.execution

Class _ProjectPlan

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.enterprise._Simple

wt.enterprise.Simple

wt.workflow.engine._WfExecutionObject

wt.workflow.engine.WfExecutionObject

wt.workflow.engine._WfContainer

wt.workflow.engine.WfContainer

wt.workflow.engine._WfProcess

wt.workflow.engine.WfProcess

wt.projmgmt.execution._ProjectPlan

All Implemented Interfaces:

Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.content._ContentHolder, ContentHolder, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.index._Indexable, Indexable, wt.inf.container._WTContained, WTContained, wt.notify._Notifiable, Notifiable, wt.ownership._Ownable, wt.ownership.Ownable, wt.project._RoleHolder, wt.project.RoleHolder, _ExecutionObject, ExecutionObject, wt.projmgmt.resource._ResourceHolder, wt.projmgmt.resource.ResourceHolder, wt.recent.RecentlyVisited, _TeamManaged, TeamManaged, wt.workflow.engine.LWWfProcessIfc, wt.workflow.forum._SubjectOfForum, SubjectOfForum, wt.workflow.notebook._SubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook

Direct Known Subclasses:

ProjectPlan

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PHASE	Description of project's stage in its execution.
static final String	SCOPE	Description of project's scope.

Fields inherited from class wt.workflow.engine._WfProcess

CREATOR, TEAM_ID

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

Fields inherited from interface wt.team._TeamManaged

TEAM_TEMPLATE_ID

Method Summary

Modifier and Type	Method	Description
Currency	getCurrentWorkCost()	Supported API: true
Timestamp	getEstimatedFinishDate()	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.
ProjectHealthStatus	getHealthStatus()	Measure of confidence of completing successfully the task or work represented by the execution object.
Timestamp	getInheritedDeadline()	Earliest date by which a containing object must be met/completed/delivered.
int	getPercentComplete()	Quantitative assessment of how close object is from being met/completed/delivered.
Work	getPerformedWork()	Work performed in a given project management object.
ProjectPhase	getPhase()	Description of project's stage in its execution.
ProjectCategory	getProjectCategory()	Classification attribute for project management objects.
String	getRiskDescription()	Longer textual qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.
ProjectRiskValue	getRiskValue()	Short qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.
String	getScope()	Description of project's scope.
String	getStatusDescription()	Textual descriptionof confidence of completing successfully the task or work represented by the execution object.
Work	getTotalWork()	Total work associated with a given project management object.
Currency	getTotalWorkCost()	Supported API: true
void	setCurrentWorkCost(Currency currentWorkCost)	Supported API: true
void	setEstimatedFinishDate(Timestamp estimatedFinishDate)	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.
void	setHealthStatus(ProjectHealthStatus healthStatus)	Measure of confidence of completing successfully the task or work represented by the execution object.
void	setInheritedDeadline(Timestamp inheritedDeadline)	Earliest date by which a containing object must be met/completed/delivered.
void	setPercentComplete(int percentComplete)	Quantitative assessment of how close object is from being met/completed/delivered.
void	setPerformedWork(Work performedWork)	Work performed in a given project management object.
void	setPhase(ProjectPhase phase)	Description of project's stage in its execution.
void	setProjectCategory(ProjectCategory projectCategory)	Classification attribute for project management objects.
void	setRiskDescription(String riskDescription)	Longer textual qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.
void	setRiskValue(ProjectRiskValue riskValue)	Short qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources.
void	setScope(String scope)	Description of project's scope.
void	setStatusDescription(String statusDescription)	Textual descriptionof confidence of completing successfully the task or work represented by the execution object.
void	setTotalWork(Work totalWork)	Total work associated with a given project management object.
void	setTotalWorkCost(Currency totalWorkCost)	Supported API: true

Methods inherited from class wt.workflow.engine._WfProcess

getCreator, getTeamId, getTeamTemplateId, setCreator

Methods inherited from class wt.workflow.engine._WfExecutionObject

getContext, getPriority, setContext, setName, 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

Methods inherited from interface wt.fc.Persistable

checkAttributes

Field Details

PHASE

public static final String 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. @see wt.projmgmt.admin.ProjectPhase @see wt.projmgmt.admin.Project2

Supported API: true

See Also:

• ProjectPlan
• Constant Field Values

SCOPE

public static final String 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. @see wt.projmgmt.admin.Project2

Supported API: true

See Also:

• ProjectPlan
• Constant Field Values

Method Details

getPhase

public ProjectPhase getPhase()

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. @see wt.projmgmt.admin.ProjectPhase @see wt.projmgmt.admin.Project2

Supported API: true

See Also:

• ProjectPlan

setPhase

public void setPhase(ProjectPhase phase)
              throws WTPropertyVetoException

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. @see wt.projmgmt.admin.ProjectPhase @see wt.projmgmt.admin.Project2

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• ProjectPlan

getScope

public String getScope()

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. @see wt.projmgmt.admin.Project2

Supported API: true

See Also:

• ProjectPlan

setScope

public void setScope(String scope)
              throws WTPropertyVetoException

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. @see wt.projmgmt.admin.Project2

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• ProjectPlan

getCurrentWorkCost

public Currency getCurrentWorkCost()

Supported API: true

Specified by:

getCurrentWorkCost in interface _ExecutionObject

See Also:

• ExecutionObject

setCurrentWorkCost

public void setCurrentWorkCost(Currency currentWorkCost)

Supported API: true

Specified by:

setCurrentWorkCost in interface _ExecutionObject

See Also:

• ExecutionObject

getEstimatedFinishDate

public Timestamp getEstimatedFinishDate()

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

See Also:

• ExecutionObject

setEstimatedFinishDate

public void setEstimatedFinishDate(Timestamp estimatedFinishDate)

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

See Also:

• ExecutionObject

getHealthStatus

public ProjectHealthStatus getHealthStatus()

Measure of confidence of completing successfully the task or work represented by the execution object. Possible values are GREEN, RED, YELLOW and UNAVAILABLE. @see wt.projmgmt.admin.ProjectHealthStatus

Supported API: true

Specified by:

getHealthStatus in interface _ExecutionObject

See Also:

• ExecutionObject

setHealthStatus

public void setHealthStatus(ProjectHealthStatus healthStatus)

Measure of confidence of completing successfully the task or work represented by the execution object. Possible values are GREEN, RED, YELLOW and UNAVAILABLE. @see wt.projmgmt.admin.ProjectHealthStatus

Supported API: true

Specified by:

setHealthStatus in interface _ExecutionObject

See Also:

• ExecutionObject

getInheritedDeadline

public Timestamp getInheritedDeadline()

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

See Also:

• ExecutionObject

setInheritedDeadline

public void setInheritedDeadline(Timestamp inheritedDeadline)

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

See Also:

• ExecutionObject

getPercentComplete

public int getPercentComplete()

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

See Also:

• ExecutionObject

setPercentComplete

public void setPercentComplete(int percentComplete)

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

See Also:

• ExecutionObject

getPerformedWork

public Work getPerformedWork()

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

See Also:

• ExecutionObject

setPerformedWork

public void setPerformedWork(Work performedWork)

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

See Also:

• ExecutionObject

getProjectCategory

public ProjectCategory getProjectCategory()

Classification attribute for project management objects. The intent is to help identification and retrieval.

Supported API: true

Specified by:

getProjectCategory in interface _ExecutionObject

See Also:

• ExecutionObject

setProjectCategory

public void setProjectCategory(ProjectCategory projectCategory)

Classification attribute for project management objects. The intent is to help identification and retrieval.

Supported API: true

Specified by:

setProjectCategory in interface _ExecutionObject

See Also:

• ExecutionObject

getRiskDescription

public String getRiskDescription()

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

See Also:

• ExecutionObject

setRiskDescription

public void setRiskDescription(String riskDescription)

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

See Also:

• ExecutionObject

getRiskValue

public ProjectRiskValue getRiskValue()

Short qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources. @see wt.projmgmt.admin.ProjectRiskValue

Supported API: true

Specified by:

getRiskValue in interface _ExecutionObject

See Also:

• ExecutionObject

setRiskValue

public void setRiskValue(ProjectRiskValue riskValue)

Short qualitative assessment of risks of meeting/completing/delivering the object within the time and available resources. @see wt.projmgmt.admin.ProjectRiskValue

Supported API: true

Specified by:

setRiskValue in interface _ExecutionObject

See Also:

• ExecutionObject

getStatusDescription

public String getStatusDescription()

Textual descriptionof confidence of completing successfully the task or work represented by the execution object.

Supported API: true

Specified by:

getStatusDescription in interface _ExecutionObject

See Also:

• ExecutionObject

setStatusDescription

public void setStatusDescription(String statusDescription)

Textual descriptionof confidence of completing successfully the task or work represented by the execution object.

Supported API: true

Specified by:

setStatusDescription in interface _ExecutionObject

See Also:

• ExecutionObject

getTotalWork

public Work getTotalWork()

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

See Also:

• ExecutionObject

setTotalWork

public void setTotalWork(Work totalWork)

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

See Also:

• ExecutionObject

getTotalWorkCost

public Currency getTotalWorkCost()

Supported API: true

Specified by:

getTotalWorkCost in interface _ExecutionObject

See Also:

• ExecutionObject

setTotalWorkCost

public void setTotalWorkCost(Currency totalWorkCost)

Supported API: true

Specified by:

setTotalWorkCost in interface _ExecutionObject

See Also:

• ExecutionObject