wt.projmgmt.resource
Interface ProjResourceServiceSvr

All Known Implementing Classes:

StandardProjResourceService

public interface ProjResourceServiceSvr

The ProjResourceServiceSvr interface contains the definition of server accessible wt.projmgmt.resource API. The access is made through the ProjResourceServerHelper.service variable.

Supported API: false

Extendable: false

See Also:

ProjResourceServerHelper

Method Summary

Currency	computeActivityCost(ProjectActivity activity, Work work) Computes the current cost for a project activity (@link wt.projmgtm.executionProjectActivity}) for a given work.
double	computeCurrentCost(ProjectActivity activity, Timestamp time) Returns current cost accrued by the activity due to use of material, equipment and facilities.
Currency	computeInitialWorkCost(ProjectActivity activity) Returns the initial work cost for a given activity.
double	computeTotalCost(ProjectActivity activity) Returns total cost to be accrued by the activity due to use of material, equipment and facilities.
Currency	computeWorkItemCost(ProjectWorkItem item, Work standard_work, Work overtime_work) Computes the current cost for a project work item given the current standard work and the current overtime work.
void	deleteContainedObjects(ProjectPlan plan) Delete all resources objects contained in the plan passed as argument.
QueryResult	getProjectPlanDeliverables(ProjectPlan plan) Returns project plan deliverables for a given ProjectPlan.
QueryResult	getUnboundProjectPlanDeliverables(ProjectPlan plan) Returns unbound project plan deliverables for a given ProjectPlan.
void	updateResourceAllocation(ExecutionObject exec_obj) Updates the resource allocation for a project work item or a project activity.

Method Detail

deleteContainedObjects

public void deleteContainedObjects(ProjectPlan plan)
                            throws WTException

Delete all resources objects contained in the plan passed as argument.

Supported API: false

Parameters:

plan -

Throws:

WTException

computeWorkItemCost

public Currency computeWorkItemCost(ProjectWorkItem item,
                                    Work standard_work,
                                    Work overtime_work)
                             throws WTException

Computes the current cost for a project work item given the current standard work and the current overtime work. For pro-rated resources, the cost is computed by extracting the rates (standard and overtime) for the owner of the item, multiplying them by the current work and adding the cost-per-use of the resource.

Supported API: false

Parameters:

item -

standard_work -

overtime_work -

Returns:

Currency

Throws:

WTException

See Also:

Work, Currency, CurrencyRate

computeActivityCost

public Currency computeActivityCost(ProjectActivity activity,
                                    Work work)
                             throws WTException

Computes the current cost for a project activity (@link wt.projmgtm.executionProjectActivity}) for a given work. Computes the total work cost for an activity and the total work passed as argument. The cost is computed by averaging all standard rates of all person resources assigned to the activity and multiplying by the given work. Also the costs per uses are summed up as well.

This is to used when the activity when the performed or total work is set at the activity level.

Supported API: false

Parameters:

activity -

work -

Returns:

Currency

Throws:

WTException

See Also:

Work, Currency, CurrencyRate

computeInitialWorkCost

public Currency computeInitialWorkCost(ProjectActivity activity)
                                throws WTException

Returns the initial work cost for a given activity. The initial work cost is the sum of all cost per uses for all assignees.

Supported API: false

Parameters:

activity -

Returns:

Currency

Throws:

WTException

computeTotalCost

public double computeTotalCost(ProjectActivity activity)
                        throws WTException

Returns total cost to be accrued by the activity due to use of material, equipment and facilities. To be added to the cost of person work to give total activity cost.

Supported API: false

Parameters:

activity -

Returns:

double

Throws:

WTException

computeCurrentCost

public double computeCurrentCost(ProjectActivity activity,
                                 Timestamp time)
                          throws WTException

Returns current cost accrued by the activity due to use of material, equipment and facilities. To be added to the cost of person work to give total activity cost. The current cost is based on the total number of rsources of the task and the number of days elapsed since the start of the activity.

Supported API: false

Parameters:

activity -

time -

Returns:

double

Throws:

WTException

getProjectPlanDeliverables

public QueryResult getProjectPlanDeliverables(ProjectPlan plan)
                                       throws WTException

Returns project plan deliverables for a given ProjectPlan. A "project deliverable" is a deliverable that has the "projectDeliverable" set to 'true'.

Supported API: false

Parameters:

plan -

Returns:

QueryResult

Throws:

WTException

getUnboundProjectPlanDeliverables

public QueryResult getUnboundProjectPlanDeliverables(ProjectPlan plan)
                                              throws WTException

Returns unbound project plan deliverables for a given ProjectPlan. A "project deliverable" is a deliverable that has the "projectDeliverable" set to 'true' and is not associated with either a milestone or an activity.

Supported API: false

Parameters:

plan -

Returns:

QueryResult

Throws:

WTException

updateResourceAllocation

public void updateResourceAllocation(ExecutionObject exec_obj)
                              throws WTException

Updates the resource allocation for a project work item or a project activity. This is called every time the duration or the total work is changed. The new allocation is computed by the formula: allocation = (100 * work) / (n * duration in days * hour per day) where n is the number of users assigned to the activity or item. For items n = 1.

Supported API: false

Parameters:

exec_obj -

Throws:

WTException