Primavera Integration API Release 8

com.primavera.common.value.spread
Interface SummaryAssignmentSpreadPeriod

All Superinterfaces:
ResourceAssignmentSpreadPeriodBase, SpreadPeriod
All Known Subinterfaces:
ProjectResourceRoleSpreadPeriod, WBSResourceRoleSpreadPeriod

public interface SummaryAssignmentSpreadPeriod
extends ResourceAssignmentSpreadPeriodBase

This interface defines all access methods for each summarized 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 period actual cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Unit getCumulativePeriodActualUnits()
          Gets the cumulative period actual units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Cost getCumulativePeriodAtCompletionCost()
          Gets the cumulative period at completion cost for this spread period, which is accumulated from the start date of the assignment until the end of this period.
 Unit getCumulativePeriodAtCompletionUnits()
          Gets the cumulative period at completion units for this spread period, which is accumulated from the start date of the assignment until the end of this period.
 Cost getCumulativeStaffedActualCost()
          Gets the cumulative staffed actual cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Cost getCumulativeStaffedActualOvertimeCost()
          Gets the cumulative staffed actual overtime cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Unit getCumulativeStaffedActualOvertimeUnits()
          Gets the cumulative staffed actual overtime units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Cost getCumulativeStaffedActualRegularCost()
          Gets the cumulative staffed actual regular cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Unit getCumulativeStaffedActualRegularUnits()
          Gets the cumulative staffed actual regular units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Unit getCumulativeStaffedActualUnits()
          Gets the cumulative staffed actual units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Cost getCumulativeStaffedAtCompletionCost()
          Gets the cumulative staffed st completion cost for this spread period, which is accumulated from the start date of the assignment until the end of this period.
 Unit getCumulativeStaffedAtCompletionUnits()
          Gets the cumulative staffed st completion units for this spread period, which is accumulated from the start date of the assignment until the end of this period.
 Cost getCumulativeStaffedPlannedCost()
          Gets the cumulative staffed planned cost for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.
 Unit getCumulativeStaffedPlannedUnits()
          Gets the cumulative staffed planned units for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.
 Cost getCumulativeUnstaffedActualCost()
          Gets the cumulative unstaffed actual cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Cost getCumulativeUnstaffedActualOvertimeCost()
          Gets the cumulative unstaffed actual overtime cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Unit getCumulativeUnstaffedActualOvertimeUnits()
          Gets the cumulative unstaffed actual overtime units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Cost getCumulativeUnstaffedActualRegularCost()
          Gets the cumulative unstaffed actual regular cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Unit getCumulativeUnstaffedActualRegularUnits()
          Gets the cumulative unstaffed actual regular units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Unit getCumulativeUnstaffedActualUnits()
          Gets the cumulative unstaffed actual units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.
 Cost getCumulativeUnstaffedAtCompletionCost()
          Gets the cumulative unstaffed st completion cost for this spread period, which is accumulated from the start date of the assignment until the end of this period.
 Unit getCumulativeUnstaffedAtCompletionUnits()
          Gets the cumulative unstaffed st completion units for this spread period, which is accumulated from the start date of the assignment until the end of this period.
 Cost getCumulativeUnstaffedPlannedCost()
          Gets the cumulative unstaffed planned cost for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.
 Unit getCumulativeUnstaffedPlannedUnits()
          Gets the cumulative unstaffed planned units for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.
 ObjectId getFinancialPeriodObjectId()
          Gets the ID of the financial period associated with this spread period.
 Unit getLimit()
          Gets the limit units for this spread period.
 Cost getPeriodActualCost()
          Gets the period actual cost for this spread period.
 Unit getPeriodActualUnits()
          Gets the period actual units for this spread period.
 Cost getPeriodAtCompletionCost()
          Gets the period at completion cost for this spread period.
 Unit getPeriodAtCompletionUnits()
          Gets the period at completion units for this spread period.
 Cost getStaffedActualCost()
          Gets the staffed actual cost for this spread period.
 Cost getStaffedActualOvertimeCost()
          Gets the staffed actual overtime cost for this spread period.
 Unit getStaffedActualOvertimeUnits()
          Gets the staffed actual overtime units for this spread period.
 Cost getStaffedActualRegularCost()
          Gets the staffed actual regular cost for this spread period.
 Unit getStaffedActualRegularUnits()
          Gets the staffed actual regular units for this spread period.
 Unit getStaffedActualUnits()
          Gets the staffed actual units for this spread period.
 Cost getStaffedAtCompletionCost()
          Gets the staffed st completion cost for this spread period.
 Unit getStaffedAtCompletionUnits()
          Gets the staffed st completion units for this spread period.
 Cost getStaffedPlannedCost()
          Gets the staffed planned cost for this spread period.
 Unit getStaffedPlannedUnits()
          Gets the staffed planned units for this spread period.
 Cost getUnstaffedActualCost()
          Gets the unstaffed actual cost for this spread period.
 Cost getUnstaffedActualOvertimeCost()
          Gets the unstaffed actual overtime cost for this spread period.
 Unit getUnstaffedActualOvertimeUnits()
          Gets the unstaffed actual overtime units for this spread period.
 Cost getUnstaffedActualRegularCost()
          Gets the unstaffed actual regular cost for this spread period.
 Unit getUnstaffedActualRegularUnits()
          Gets the unstaffed actual regular units for this spread period.
 Unit getUnstaffedActualUnits()
          Gets the unstaffed actual units for this spread period.
 Cost getUnstaffedAtCompletionCost()
          Gets the unstaffed st completion cost for this spread period.
 Unit getUnstaffedAtCompletionUnits()
          Gets the unstaffed st completion units for this spread period.
 Cost getUnstaffedPlannedCost()
          Gets the unstaffed planned cost for this spread period.
 Unit getUnstaffedPlannedUnits()
          Gets the unstaffed planned 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

getFinancialPeriodObjectId

ObjectId getFinancialPeriodObjectId()
Gets the ID of the financial period associated with this spread period. In non-financial period spreads, this value will be null.

Returns:
The ID of the financial period that this spread represents, or null if the spread is not a financial period spread

getStaffedActualCost

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

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

getCumulativeStaffedActualCost

Cost getCumulativeStaffedActualCost()
                                    throws SpreadFieldNotFoundException,
                                           SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed actual cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getUnstaffedActualCost

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

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

getCumulativeUnstaffedActualCost

Cost getCumulativeUnstaffedActualCost()
                                      throws SpreadFieldNotFoundException,
                                             SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed actual cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getStaffedActualOvertimeCost

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

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

getCumulativeStaffedActualOvertimeCost

Cost getCumulativeStaffedActualOvertimeCost()
                                            throws SpreadFieldNotFoundException,
                                                   SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed actual overtime cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getUnstaffedActualOvertimeCost

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

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

getCumulativeUnstaffedActualOvertimeCost

Cost getCumulativeUnstaffedActualOvertimeCost()
                                              throws SpreadFieldNotFoundException,
                                                     SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed actual overtime cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getStaffedActualOvertimeUnits

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

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

getCumulativeStaffedActualOvertimeUnits

Unit getCumulativeStaffedActualOvertimeUnits()
                                             throws SpreadFieldNotFoundException,
                                                    SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed actual overtime units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getUnstaffedActualOvertimeUnits

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

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

getCumulativeUnstaffedActualOvertimeUnits

Unit getCumulativeUnstaffedActualOvertimeUnits()
                                               throws SpreadFieldNotFoundException,
                                                      SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed actual overtime units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getStaffedActualRegularCost

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

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

getCumulativeStaffedActualRegularCost

Cost getCumulativeStaffedActualRegularCost()
                                           throws SpreadFieldNotFoundException,
                                                  SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed actual regular cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getUnstaffedActualRegularCost

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

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

getCumulativeUnstaffedActualRegularCost

Cost getCumulativeUnstaffedActualRegularCost()
                                             throws SpreadFieldNotFoundException,
                                                    SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed actual regular cost for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getStaffedActualRegularUnits

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

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

getCumulativeStaffedActualRegularUnits

Unit getCumulativeStaffedActualRegularUnits()
                                            throws SpreadFieldNotFoundException,
                                                   SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed actual regular units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getUnstaffedActualRegularUnits

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

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

getCumulativeUnstaffedActualRegularUnits

Unit getCumulativeUnstaffedActualRegularUnits()
                                              throws SpreadFieldNotFoundException,
                                                     SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed actual regular units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getStaffedActualUnits

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

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

getCumulativeStaffedActualUnits

Unit getCumulativeStaffedActualUnits()
                                     throws SpreadFieldNotFoundException,
                                            SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed actual units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getUnstaffedActualUnits

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

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

getCumulativeUnstaffedActualUnits

Unit getCumulativeUnstaffedActualUnits()
                                       throws SpreadFieldNotFoundException,
                                              SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed actual units for this spread period, which is accumulated from the actual start date of the assignment until the end of this period.

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

getStaffedAtCompletionCost

Cost getStaffedAtCompletionCost()
                                throws SpreadFieldNotFoundException
Gets the staffed st completion cost for this spread period.

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

getCumulativeStaffedAtCompletionCost

Cost getCumulativeStaffedAtCompletionCost()
                                          throws SpreadFieldNotFoundException,
                                                 SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed st completion cost for this spread period, which is accumulated from the start date of the assignment until the end of this period.

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

getUnstaffedAtCompletionCost

Cost getUnstaffedAtCompletionCost()
                                  throws SpreadFieldNotFoundException
Gets the unstaffed st completion cost for this spread period.

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

getCumulativeUnstaffedAtCompletionCost

Cost getCumulativeUnstaffedAtCompletionCost()
                                            throws SpreadFieldNotFoundException,
                                                   SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed st completion cost for this spread period, which is accumulated from the start date of the assignment until the end of this period.

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

getStaffedAtCompletionUnits

Unit getStaffedAtCompletionUnits()
                                 throws SpreadFieldNotFoundException
Gets the staffed st completion units for this spread period.

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

getCumulativeStaffedAtCompletionUnits

Unit getCumulativeStaffedAtCompletionUnits()
                                           throws SpreadFieldNotFoundException,
                                                  SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed st completion units for this spread period, which is accumulated from the start date of the assignment until the end of this period.

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

getUnstaffedAtCompletionUnits

Unit getUnstaffedAtCompletionUnits()
                                   throws SpreadFieldNotFoundException
Gets the unstaffed st completion units for this spread period.

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

getCumulativeUnstaffedAtCompletionUnits

Unit getCumulativeUnstaffedAtCompletionUnits()
                                             throws SpreadFieldNotFoundException,
                                                    SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed st completion units for this spread period, which is accumulated from the start date of the assignment until the end of this period.

Returns:
the cumulative unstaffed st 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 period actual cost for this spread period.

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

getCumulativePeriodActualCost

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

Returns:
the cumulative period 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 period actual units for this spread period.

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

getCumulativePeriodActualUnits

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

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

getPeriodAtCompletionCost

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

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

getCumulativePeriodAtCompletionCost

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

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

getPeriodAtCompletionUnits

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

Returns:
the period at completion units in hours
Throws:
SpreadFieldNotFoundException - if this field was not loaded

getCumulativePeriodAtCompletionUnits

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

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

getStaffedPlannedCost

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

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

getCumulativeStaffedPlannedCost

Cost getCumulativeStaffedPlannedCost()
                                     throws SpreadFieldNotFoundException,
                                            SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed planned cost for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.

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

getUnstaffedPlannedCost

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

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

getCumulativeUnstaffedPlannedCost

Cost getCumulativeUnstaffedPlannedCost()
                                       throws SpreadFieldNotFoundException,
                                              SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed planned cost for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.

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

getStaffedPlannedUnits

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

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

getCumulativeStaffedPlannedUnits

Unit getCumulativeStaffedPlannedUnits()
                                      throws SpreadFieldNotFoundException,
                                             SpreadCumulativeDataNotLoadedException
Gets the cumulative staffed planned units for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.

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

getUnstaffedPlannedUnits

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

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

getCumulativeUnstaffedPlannedUnits

Unit getCumulativeUnstaffedPlannedUnits()
                                        throws SpreadFieldNotFoundException,
                                               SpreadCumulativeDataNotLoadedException
Gets the cumulative unstaffed planned units for this spread period, which is accumulated from the planned start date of the assignment until the end of this period.

Returns:
the cumulative unstaffed planned 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 Release 8

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