Package com.primavera.common.value.spread

Interface ExpenseCategoryCBSSpreadPeriod

All Superinterfaces:

SpreadPeriod

public interface ExpenseCategoryCBSSpreadPeriod
extends SpreadPeriod

Method Summary

Modifier and Type	Method	Description
Unit	getActualUnits()	Gets the actual units for this spread period.
Unit	getAtCompletionUnits()	Gets the at completion units for this spread period.
Unit	getCumulativeActualUnits()	Gets the cumulative actual 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.
Unit	getCumulativePlannedUnits()	Gets the cumulative planned untis for this spread period, which is cumulated from the start date to the end of this period.
Unit	getCumulativeRemainingUnits()	Gets the cumulative remaining for this spread period, which is cumulated from the start date to the end of this period.
Unit	getPlannedUnits()	Gets the planned units 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

Throws:

SpreadFieldNotFoundException - if this field was not loaded

getCumulativePlannedUnits

Unit getCumulativePlannedUnits()
                        throws SpreadFieldNotFoundException,
SpreadCumulativeDataNotLoadedException

Gets the cumulative planned untis for this spread period, which is cumulated from the start date to the end of this period.

Returns:

the cumulative planned units

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

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 start date to the end of this period.

Returns:

the cumulative actual units

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

Throws:

SpreadFieldNotFoundException - if this field was not loaded

getCumulativeRemainingUnits

Unit getCumulativeRemainingUnits()
                          throws SpreadFieldNotFoundException,
SpreadCumulativeDataNotLoadedException

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

Returns:

the remaining units

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

Throws:

SpreadFieldNotFoundException - if this field was not 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 cumulative at completion units

Throws:

SpreadFieldNotFoundException - if this field was not loaded

SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded