Interface SummaryAssignmentSpreadPeriod
- All Superinterfaces:
ResourceAssignmentSpreadPeriodBase,SpreadPeriod
- All Known Subinterfaces:
ProjectResourceRoleSpreadPeriod,WBSResourceRoleSpreadPeriod
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
Modifier and TypeMethodDescriptionGets the cumulative limit units for this spread period, which is cumulated from the actual start to the end of this period.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.Gets the ID of the financial period associated with this spread period.getLimit()Gets the limit units for this spread period.Gets the period actual cost for this spread period.Gets the period actual units for this spread period.Gets the period at completion cost for this spread period.Gets the period at completion units for this spread period.Gets the staffed actual cost for this spread period.Gets the staffed actual overtime cost for this spread period.Gets the staffed actual overtime units for this spread period.Gets the staffed actual regular cost for this spread period.Gets the staffed actual regular units for this spread period.Gets the staffed actual units for this spread period.Gets the staffed st completion cost for this spread period.Gets the staffed st completion units for this spread period.Gets the staffed planned cost for this spread period.Gets the staffed planned units for this spread period.Gets the unstaffed actual cost for this spread period.Gets the unstaffed actual overtime cost for this spread period.Gets the unstaffed actual overtime units for this spread period.Gets the unstaffed actual regular cost for this spread period.Gets the unstaffed actual regular units for this spread period.Gets the unstaffed actual units for this spread period.Gets the unstaffed st completion cost for this spread period.Gets the unstaffed st completion units for this spread period.Gets the unstaffed planned cost for this spread period.Gets the unstaffed planned units for this spread period.Methods inherited from interface com.primavera.common.value.spread.ResourceAssignmentSpreadPeriodBase
getActualCost, getActualOvertimeCost, getActualOvertimeUnits, getActualPeriodCost, getActualPeriodUnits, getActualRegularCost, getActualRegularUnits, getActualUnits, getAtCompletionCost, getAtCompletionPeriodCost, getAtCompletionPeriodUnits, 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, getUnstaffedRemainingUnitsMethods inherited from interface com.primavera.common.value.spread.SpreadPeriod
getCost, getCumulativeCost, getCumulativeUnits, getSpreadBucketType, getSpreadBucketTypeEnum, getSpreadPeriodEnd, getSpreadPeriodStart, getUnits, setCost, setUnits
-
Method Details
-
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
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedActualCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedActualOvertimeCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedActualOvertimeCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedActualOvertimeUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedActualOvertimeUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedActualRegularCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedActualRegularCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedActualRegularUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedActualRegularUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedActualUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedActualUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedAtCompletionCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedAtCompletionCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedAtCompletionUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedAtCompletionUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getPeriodActualCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getPeriodActualUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getPeriodAtCompletionCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getPeriodAtCompletionUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedPlannedCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedPlannedCost
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getStaffedPlannedUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getUnstaffedPlannedUnits
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getLimit
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, SpreadCumulativeDataNotLoadedExceptionGets 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 loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-