Primavera Integration API 7.0

com.primavera.common.value.spread
Interface ProjectResourceRoleSpreadPeriod

All Superinterfaces:
com.primavera.common.value.spread.ResourceAssignmentSpreadPeriodBase, SpreadPeriod

public interface ProjectResourceRoleSpreadPeriod
extends com.primavera.common.value.spread.ResourceAssignmentSpreadPeriodBase

This interface defines all access methods for each resource/role assignment spread period. The spread period is calculated according to the bucket type.


Method Summary
 Unit getCumulativeLimit()
          Gets the cumulative limit units for this spread period, which is cumulated from the actual start to the end of this period.
 Cost getCumulativePeriodActualCost()
          Gets the cumulative actual cost for this spread period, which is cumulated from the actual start to the end of this period.
 Unit getCumulativePeriodActualUnits()
          Gets the cumulative actual units for this spread period, which is cumulated from the actual start to the end of this period.
 Cost getCumulativePeriodAtCompletionCost()
          Gets the cumulative at completion cost for this spread period, which is cumulated from the start date to the end of this period.
 Unit getCumulativePeriodAtCompletionUnits()
          Gets the cumulative at completion units for this spread period, which is cumulated from the start date to the end of this period.
 Unit getLimit()
          Gets the limit units for this spread period.
 Cost getPeriodActualCost()
          Gets the actual cost for this spread period.
 Unit getPeriodActualUnits()
          Gets the actual units for this spread period.
 Cost getPeriodAtCompletionCost()
          Gets the at completion cost for this spread period.
 Unit getPeriodAtCompletionUnits()
          Gets the at completion units for this spread period.
 
Methods inherited from interface com.primavera.common.value.spread.ResourceAssignmentSpreadPeriodBase
getActualCost, getActualOvertimeCost, getActualOvertimeUnits, getActualRegularCost, getActualRegularUnits, getActualUnits, getAtCompletionCost, getAtCompletionUnits, getCumulativeActualCost, getCumulativeActualOvertimeCost, getCumulativeActualOvertimeUnits, getCumulativeActualRegularCost, getCumulativeActualRegularUnits, getCumulativeActualUnits, getCumulativeAtCompletionCost, getCumulativeAtCompletionUnits, getCumulativePlannedCost, getCumulativePlannedUnits, getCumulativeRemainingCost, getCumulativeRemainingLateCost, getCumulativeRemainingLateUnits, getCumulativeRemainingUnits, getCumulativeStaffedRemainingCost, getCumulativeStaffedRemainingLateCost, getCumulativeStaffedRemainingLateUnits, getCumulativeStaffedRemainingUnits, getCumulativeUnstaffedRemainingCost, getCumulativeUnstaffedRemainingLateCost, getCumulativeUnstaffedRemainingLateUnits, getCumulativeUnstaffedRemainingUnits, getPlannedCost, getPlannedUnits, getRemainingCost, getRemainingLateCost, getRemainingLateUnits, getRemainingUnits, getStaffedRemainingCost, getStaffedRemainingLateCost, getStaffedRemainingLateUnits, getStaffedRemainingUnits, getUnstaffedRemainingCost, getUnstaffedRemainingLateCost, getUnstaffedRemainingLateUnits, getUnstaffedRemainingUnits
 
Methods inherited from interface com.primavera.common.value.spread.SpreadPeriod
getCost, getCumulativeCost, getCumulativeUnits, getSpreadBucketType, getSpreadBucketTypeEnum, getSpreadPeriodEnd, getSpreadPeriodStart, getUnits, setCost, setUnits
 

Method Detail

getPeriodAtCompletionCost

Cost getPeriodAtCompletionCost()
                               throws SpreadFieldNotFoundException
Gets the at completion cost for this spread period.

Returns:
the at completion cost in default currency units
Throws:
SpreadFieldNotFoundException - if this field was not loaded

getCumulativePeriodAtCompletionCost

Cost getCumulativePeriodAtCompletionCost()
                                         throws SpreadFieldNotFoundException,
                                                SpreadCumulativeDataNotLoadedException
Gets the cumulative at completion cost for this spread period, which is cumulated from the start date to the end of this period.

Returns:
the cumulated at completion cost in default currency hour.
Throws:
SpreadFieldNotFoundException - if this field was not loaded
SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded

getPeriodAtCompletionUnits

Unit getPeriodAtCompletionUnits()
                                throws SpreadFieldNotFoundException,
                                       SpreadCumulativeDataNotLoadedException
Gets the at completion units for this spread period.

Returns:
the at completion units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded
SpreadCumulativeDataNotLoadedException - if the spread cumulative data has not been loaded

getCumulativePeriodAtCompletionUnits

Unit getCumulativePeriodAtCompletionUnits()
                                          throws SpreadFieldNotFoundException,
                                                 SpreadCumulativeDataNotLoadedException
Gets the cumulative at completion units for this spread period, which is cumulated from the start date to the end of this period.

Returns:
the cumulated at completion units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded
SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded

getPeriodActualCost

Cost getPeriodActualCost()
                         throws SpreadFieldNotFoundException
Gets the actual cost for this spread period.

Returns:
the actual cost in default currency units
Throws:
SpreadFieldNotFoundException - if this field was not loaded

getCumulativePeriodActualCost

Cost getCumulativePeriodActualCost()
                                   throws SpreadFieldNotFoundException,
                                          SpreadCumulativeDataNotLoadedException
Gets the cumulative actual cost for this spread period, which is cumulated from the actual start to the end of this period.

Returns:
the cumulated actual cost in default currency units
Throws:
SpreadFieldNotFoundException - if this field was not loaded
SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded

getPeriodActualUnits

Unit getPeriodActualUnits()
                          throws SpreadFieldNotFoundException
Gets the actual units for this spread period.

Returns:
the actual units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded

getCumulativePeriodActualUnits

Unit getCumulativePeriodActualUnits()
                                    throws SpreadFieldNotFoundException,
                                           SpreadCumulativeDataNotLoadedException
Gets the cumulative actual units for this spread period, which is cumulated from the actual start to the end of this period.

Returns:
the cumulated actual units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded
SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded

getLimit

Unit getLimit()
              throws SpreadFieldNotFoundException
Gets the limit units for this spread period.

Returns:
the limit units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded

getCumulativeLimit

Unit getCumulativeLimit()
                        throws SpreadFieldNotFoundException,
                               SpreadCumulativeDataNotLoadedException
Gets the cumulative limit units for this spread period, which is cumulated from the actual start to the end of this period.

Returns:
the cumulated limit units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded
SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.