Primavera Integration API Release 8

com.primavera.common.value.spread
Class WBSRoleSpread

java.lang.Object
  extended by com.primavera.common.value.spread.BaseSpread
      extended by com.primavera.common.value.spread.ResourceAssignmentBaseSpread
          extended by com.primavera.common.value.spread.SummaryAssignmentSpread
              extended by com.primavera.common.value.spread.WBSResourceRoleSpread
                  extended by com.primavera.common.value.spread.WBSRoleSpread
All Implemented Interfaces:
Serializable, Cloneable, Iterable<SpreadPeriod>

public class WBSRoleSpread
extends WBSResourceRoleSpread

Role assignment spread, containing unit and/or cost fields that have been spread for a particular Role within a particular WBS over zero to many spread periods. For assignment spread data to be successfully loaded, the summarizer job service must have first been run on the project containing that particular WBS and the project must be configured to summarize assignments to the level in the WBS hierarchy where that WBS is located.

See the description in BaseSpread for information on how to access the loaded spread data.

See Also:
Serialized Form

Constructor Summary
WBSRoleSpread(SpreadData spreadData)
          Constructor that creates WBSRoleSpread object from which all Role spread data for a WBS can be accessed.
 
Method Summary
 ObjectId getRoleObjectId()
          Gets the unique ID of the associated Role object
 void setRoleObjectId(ObjectId roleObjectId)
          Sets the unique ID of the associated Role object
 
Methods inherited from class com.primavera.common.value.spread.WBSResourceRoleSpread
getWBSObjectId, setWBSObjectId
 
Methods inherited from class com.primavera.common.value.spread.SummaryAssignmentSpread
getActualFinishDate, getActualStartDate, getRemainingFinishDate, getRemainingStartDate, getResourceType, setActualFinishDate, setActualStartDate, setFinancialPeriodIds, setRemainingFinishDate, setRemainingStartDate, setResourceType
 
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

WBSRoleSpread

public WBSRoleSpread(SpreadData spreadData)
Constructor that creates WBSRoleSpread object from which all Role spread data for a WBS can be accessed.

Parameters:
spreadData - the actual object which holds the spread data
Method Detail

getRoleObjectId

public ObjectId getRoleObjectId()
Gets the unique ID of the associated Role object

Returns:
the unique ID of the Role

setRoleObjectId

public void setRoleObjectId(ObjectId roleObjectId)
Sets the unique ID of the associated Role object

Parameters:
roleObjectId - the unique ID of the Role

Primavera Integration API Release 8

Copyright © 2003, 2010, Oracle and/or its affiliates. All rights reserved.