Interface SpreadPeriod
- All Known Subinterfaces:
ActivitySpreadPeriod,EPSSpreadPeriod,ExpenseCategoryCBSSpreadPeriod,ProjectResourceRoleSpreadPeriod,ProjectSpreadPeriod,ResourceAssignmentCBSSpreadPeriodBase,ResourceAssignmentSpreadPeriod,ResourceAssignmentSpreadPeriodBase,SummaryAssignmentSpreadPeriod,WBSResourceRoleSpreadPeriod,WBSSpreadPeriod
public interface SpreadPeriod
The base class of all spread period interfaces
-
Method Summary
Modifier and TypeMethodDescriptionGets the cost value of the specified field in this spread period.getCumulativeCost(String fieldName) Gets the cumulative cost value of the specified field in this spread period.getCumulativeUnits(String fieldName) Gets the cumulative unit value of the specified field in this spread period.intGets the bucket type of this spread period.Gets the bucket type of this spread period in enum.Gets the end time of this spread period.Gets the start time of this spread period.Gets the unit value of the specified field in this spread period.voidSets the cost value of the specified field in this spread period.voidSets the unit value of the specified field in this spread period.
-
Method Details
-
getSpreadPeriodStart
Date getSpreadPeriodStart()Gets the start time of this spread period.- Returns:
- the start time of this spread period
-
getSpreadPeriodEnd
Date getSpreadPeriodEnd()Gets the end time of this spread period.- Returns:
- the end time of this spread period
-
getSpreadBucketType
int getSpreadBucketType()Gets the bucket type of this spread period.- Returns:
- the bucket type
-
getSpreadBucketTypeEnum
SpreadBucketType getSpreadBucketTypeEnum()Gets the bucket type of this spread period in enum.- Returns:
- the bucket type enum
-
getUnits
Gets the unit value of the specified field in this spread period.- Parameters:
fieldName- the spread field name- Returns:
- the spreaded unit value of this field
- Throws:
SpreadFieldNotFoundException- if the unit field was not loaded
-
getCost
Gets the cost value of the specified field in this spread period.- Parameters:
fieldName- the spread field name- Returns:
- the spreaded cost value of this field
- Throws:
SpreadFieldNotFoundException- if the cost field was not loaded
-
getCumulativeUnits
Unit getCumulativeUnits(String fieldName) throws SpreadFieldNotFoundException, SpreadCumulativeDataNotLoadedException Gets the cumulative unit value of the specified field in this spread period.- Parameters:
fieldName- the spread field name- Returns:
- the cumulative spreaded unit value of this field
- Throws:
SpreadFieldNotFoundException- if the unit field was not loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
getCumulativeCost
Cost getCumulativeCost(String fieldName) throws SpreadFieldNotFoundException, SpreadCumulativeDataNotLoadedException Gets the cumulative cost value of the specified field in this spread period.- Parameters:
fieldName- the spread field name- Returns:
- the cumulative spreaded cost value of this field
- Throws:
SpreadFieldNotFoundException- if the cost field was not loadedSpreadCumulativeDataNotLoadedException- if cumulative data was not loaded
-
setUnits
void setUnits(String fieldName, Unit units) throws SpreadFieldNotFoundException, SpreadNonEditableException Sets the unit value of the specified field in this spread period.- Parameters:
fieldName- the spread field nameunits- the new unit value of the spread field- Throws:
SpreadFieldNotFoundException- if the unit field was not foundSpreadNonEditableException- if the unit field is not editable
-
setCost
void setCost(String fieldName, Cost cost) throws SpreadFieldNotFoundException, SpreadNonEditableException Sets the cost value of the specified field in this spread period.- Parameters:
fieldName- the spread field namecost- the new cost value of the spread field- Throws:
SpreadFieldNotFoundException- if the cost field was not foundSpreadNonEditableException- if the cost field is not editable
-