Package com.primavera.common.value.spread

Interface ResourceAssignmentCBSSpreadPeriodBase

All Superinterfaces:

SpreadPeriod

public interface ResourceAssignmentCBSSpreadPeriodBase
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

Modifier and Type	Method	Description
Cost	getActualCost()	Gets the actual cost for this spread period.
Cost	getActualPeriodCost()	Gets the actual period cost for this spread period.
Unit	getActualPeriodUnits()	Gets the actual period 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.
Cost	getAtCompletionPeriodCost()	Gets the at completion period cost for this spread period.
Unit	getAtCompletionPeriodUnits()	Gets the at completion period units 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	getCumulativeActualPeriodCost()	Gets the cumulative actual period cost for this spread period, which is cumulated from the actual start to the end of this period.
Unit	getCumulativeActualPeriodUnits()	Gets the cumulative actual period 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.
Cost	getCumulativeAtCompletionPeriodCost()	Gets the cumulative at completion period cost for this spread period, which is cumulated from the start date to the end of this period.
Unit	getCumulativeAtCompletionPeriodUnits()	Gets the cumulative at completion period units 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.
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	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.
Unit	getRemainingUnits()	Gets the 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 Details

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

getActualPeriodUnits

Unit getActualPeriodUnits()
                   throws SpreadFieldNotFoundException

Gets the actual period units for this spread period.

Returns:

the actual period units in hours

Throws:

SpreadFieldNotFoundException - if this field was not loaded

getCumulativeActualPeriodUnits

Unit getCumulativeActualPeriodUnits()
                             throws SpreadFieldNotFoundException,
SpreadCumulativeDataNotLoadedException

Gets the cumulative actual period units for this spread period, which is cumulated from the actual start to the end of this period.

Returns:

the cumulated actual period 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

getAtCompletionUnits

Unit getAtCompletionUnits()
                   throws SpreadFieldNotFoundException

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

getAtCompletionPeriodUnits

Unit getAtCompletionPeriodUnits()
                         throws SpreadFieldNotFoundException

Gets the at completion period units for this spread period.

Returns:

the at completion period units in hours

Throws:

SpreadFieldNotFoundException - if this field was not loaded

SpreadCumulativeDataNotLoadedException - if the spread cumulative data has not been loaded

getCumulativeAtCompletionPeriodUnits

Unit getCumulativeAtCompletionPeriodUnits()
                                   throws SpreadFieldNotFoundException,
SpreadCumulativeDataNotLoadedException

Gets the cumulative at completion period units for this spread period, which is cumulated from the start date to the end of this period.

Returns:

the cumulated at completion period 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

getActualPeriodCost

Cost getActualPeriodCost()
                  throws SpreadFieldNotFoundException

Gets the actual period cost for this spread period.

Returns:

the actual period cost in default currency units

Throws:

SpreadFieldNotFoundException - if this field was not loaded

getCumulativeActualPeriodCost

Cost getCumulativeActualPeriodCost()
                            throws SpreadFieldNotFoundException,
SpreadCumulativeDataNotLoadedException

Gets the cumulative actual period cost for this spread period, which is cumulated from the actual start to the end of this period.

Returns:

the cumulated actual period 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

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

getAtCompletionPeriodCost

Cost getAtCompletionPeriodCost()
                        throws SpreadFieldNotFoundException

Gets the at completion period cost for this spread period.

Returns:

the at completion period cost in default currency units

Throws:

SpreadFieldNotFoundException - if this field was not loaded

getCumulativeAtCompletionPeriodCost

Cost getCumulativeAtCompletionPeriodCost()
                                  throws SpreadFieldNotFoundException,
SpreadCumulativeDataNotLoadedException

Gets the cumulative at completion period cost for this spread period, which is cumulated from the start date to the end of this period.

Returns:

the cumulated at completion period cost in default currency hour.

Throws:

SpreadFieldNotFoundException - if this field was not loaded

SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded