Primavera Integration API Release 8

com.primavera.common.value.spread
Interface ResourceAssignmentSpreadPeriodBase

All Superinterfaces:
SpreadPeriod
All Known Subinterfaces:
ProjectResourceRoleSpreadPeriod, ResourceAssignmentSpreadPeriod, SummaryAssignmentSpreadPeriod, WBSResourceRoleSpreadPeriod

public interface ResourceAssignmentSpreadPeriodBase
extends SpreadPeriod

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


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

Method Detail

getPlannedUnits

Unit getPlannedUnits()
                     throws SpreadFieldNotFoundException
Gets the planned units for this spread period.

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

getCumulativePlannedUnits

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

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

getActualUnits

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

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

getCumulativeActualUnits

Unit getCumulativeActualUnits()
                              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

getActualRegularUnits

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

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

getCumulativeActualRegularUnits

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

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

getActualOvertimeUnits

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

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

getCumulativeActualOvertimeUnits

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

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

getRemainingUnits

Unit getRemainingUnits()
                       throws SpreadFieldNotFoundException
Gets the remaining units for this spread period.

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

getCumulativeRemainingUnits

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

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

getRemainingLateUnits

Unit getRemainingLateUnits()
                           throws SpreadFieldNotFoundException
Gets the remaining late units for this spread period.

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

getCumulativeRemainingLateUnits

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

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

getStaffedRemainingUnits

Unit getStaffedRemainingUnits()
                              throws SpreadFieldNotFoundException
Gets the staffed remaining units for this spread period.

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

getCumulativeStaffedRemainingUnits

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

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

getStaffedRemainingLateUnits

Unit getStaffedRemainingLateUnits()
                                  throws SpreadFieldNotFoundException
Gets the staffed remaining late units for this spread period.

Returns:
the staffed remaining late units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded

getCumulativeStaffedRemainingLateUnits

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

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

getUnstaffedRemainingUnits

Unit getUnstaffedRemainingUnits()
                                throws SpreadFieldNotFoundException
Gets the unstaffed remaining units for this spread period.

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

getCumulativeUnstaffedRemainingUnits

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

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

getUnstaffedRemainingLateUnits

Unit getUnstaffedRemainingLateUnits()
                                    throws SpreadFieldNotFoundException
Gets the unstaffed remaining late units for this spread period.

Returns:
the unstaffed remaining late units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded

getCumulativeUnstaffedRemainingLateUnits

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

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

getAtCompletionUnits

Unit getAtCompletionUnits()
                          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

getCumulativeAtCompletionUnits

Unit getCumulativeAtCompletionUnits()
                                    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

getPlannedCost

Cost getPlannedCost()
                    throws SpreadFieldNotFoundException
Gets the planned cost for this spread period.

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

getCumulativePlannedCost

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

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

getActualCost

Cost getActualCost()
                   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

getCumulativeActualCost

Cost getCumulativeActualCost()
                             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

getActualRegularCost

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

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

getCumulativeActualRegularCost

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

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

getActualOvertimeCost

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

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

getCumulativeActualOvertimeCost

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

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

getRemainingCost

Cost getRemainingCost()
                      throws SpreadFieldNotFoundException
Gets the remaining cost for this spread period.

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

getCumulativeRemainingCost

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

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

getRemainingLateCost

Cost getRemainingLateCost()
                          throws SpreadFieldNotFoundException
Gets the remaining late cost for this spread period.

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

getCumulativeRemainingLateCost

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

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

getStaffedRemainingCost

Cost getStaffedRemainingCost()
                             throws SpreadFieldNotFoundException
Gets the staffed remaining cost for this spread period.

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

getCumulativeStaffedRemainingCost

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

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

getStaffedRemainingLateCost

Cost getStaffedRemainingLateCost()
                                 throws SpreadFieldNotFoundException
Gets the staffed remaining late cost for this spread period.

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

getCumulativeStaffedRemainingLateCost

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

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

getUnstaffedRemainingCost

Cost getUnstaffedRemainingCost()
                               throws SpreadFieldNotFoundException
Gets the unstaffed remaining cost for this spread period.

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

getCumulativeUnstaffedRemainingCost

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

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

getUnstaffedRemainingLateCost

Cost getUnstaffedRemainingLateCost()
                                   throws SpreadFieldNotFoundException
Gets the unstaffed remaining late cost for this spread period.

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

getCumulativeUnstaffedRemainingLateCost

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

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

getAtCompletionCost

Cost getAtCompletionCost()
                         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

getCumulativeAtCompletionCost

Cost getCumulativeAtCompletionCost()
                                   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

Primavera Integration API Release 8

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