|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.common.value.spread.BaseSpread
com.primavera.common.value.spread.ResourceAssignmentBaseSpread
com.primavera.common.value.spread.ResourceAssignmentSpread
public class ResourceAssignmentSpread
Resource assignment spreads contain unit and/or cost fields for a particular resource assignment that have been spread over zero to many spread periods. Resource assignment spreads are calculated live and therefore can be used without running the summarizer job service.
To edit future bucket planning data, edit the values on an associated ResourceAssignmentSpreadPeriod instance. Then call the ResourceAssignment.setResourceAssignmentSpread() method before using the ResourceAssignment.setResourceAssignmentSpread() method to update the ResourceAssignment.
See the description in BaseSpread for information on how to access the loaded spread data.
Constructor Summary | |
---|---|
ResourceAssignmentSpread(SpreadBucketType bucketType)
Creates a new resource assignment instance for update. |
|
ResourceAssignmentSpread(SpreadData spreadData)
Constructor. |
Method Summary | |
---|---|
ResourceAssignmentSpreadPeriod |
addSpreadPeriod(Date date)
Add a spread period at the specified date |
boolean |
isPlannedUnitsEdited()
Gets the flag indicating whether the planned units were edited in this spread |
boolean |
isRemainingUnitsEdited()
Gets the flag indicating whether the remaining units were edited in this spread |
void |
setFinancialPeriods(com.primavera.common.value.spread.FinancialPeriodDates[] finPeriodDates)
Sets the financial period dates for this spread; this method is internal and should not be called by client code. |
void |
setStartDayOfWeek(int weekStart)
Sets the start day of the week for this spread. |
Methods inherited from class com.primavera.common.value.spread.BaseSpread |
---|
clearFinancialValues, ensureSpreadSpansDate, getCostFields, getSpreadBucketType, getSpreadBucketTypeEnum, getSpreadEnd, getSpreadIterator, getSpreadPeriod, getSpreadStart, getUnitFields, hasCumulativeData, iterator, recycle, size, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ResourceAssignmentSpread(SpreadBucketType bucketType)
bucketType
- the bucket type in updating (Day, Week, Month, Financial Period, etc)public ResourceAssignmentSpread(SpreadData spreadData)
spreadData
- the actual object which holds spread dataMethod Detail |
---|
public ResourceAssignmentSpreadPeriod addSpreadPeriod(Date date) throws SpreadNonEditableException
date
- A date within the current period
SpreadNonEditableException
- if this spread is not editablepublic void setStartDayOfWeek(int weekStart)
weekStart
- the start day of the week: Sunday = 1, Monday = 2, etc.public void setFinancialPeriods(com.primavera.common.value.spread.FinancialPeriodDates[] finPeriodDates)
finPeriodDates
- an array of financial period datespublic boolean isPlannedUnitsEdited()
public boolean isRemainingUnitsEdited()
|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |