Primavera Integration API Release 8

com.primavera.common.value.spread
Class SummaryAssignmentSpread

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
All Implemented Interfaces:
Serializable, Cloneable, Iterable<SpreadPeriod>
Direct Known Subclasses:
ProjectResourceRoleSpread, WBSResourceRoleSpread

public abstract class SummaryAssignmentSpread
extends ResourceAssignmentBaseSpread

Base class for summarized Resource/Role assignment spread data. This object contains unit and/or cost fields that have been spread for a particular Resource/Role over zero to many spread periods.

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

See Also:
Serialized Form

Constructor Summary
SummaryAssignmentSpread(SpreadData spreadData)
           
 
Method Summary
 Date getActualFinishDate()
          The latest actual finish date for this summarized assignment, or null if any of the assignments have not finished.
 Date getActualStartDate()
          The earliest actual start date for this summarized assignment, or null if none of the assignments have started.
 Date getRemainingFinishDate()
          Returns the latest remaining finish date for this summarized assignment, or null if all assignments have been completed.
 Date getRemainingStartDate()
          The earliest remaining start date for this summarized assignment, or null if all assignments have been completed.
 String getResourceType()
          The resource type for this summarized assignment, possible values are: LABOR for labor Resources NONLABOR for non-labor Resources MATERIAL for material Resources null for Roles
 void setActualFinishDate(Date actualFinishDate)
          Sets the actual finish date value for this summarized assignment.
 void setActualStartDate(Date actualStartDate)
          Sets the actual start date value for this summarized assignment.
 void setFinancialPeriodIds(Map<Date,ObjectId> financialPeriodIds)
          Sets the map that enables each SpreadPeriod to determine which financial period it corresponds to.
 void setRemainingFinishDate(Date remainingFinishDate)
          Sets the remaining finish date value for this summarized assignment.
 void setRemainingStartDate(Date remainingStartDate)
          Sets the remaining start date value for this summarized assignment.
 void setResourceType(String resourceType)
          Sets the resource type for this summarized assignment, valid values are: LABOR for labor Resources NONLABOR for non-labor Resources MATERIAL for material Resources null for Roles
 
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

SummaryAssignmentSpread

public SummaryAssignmentSpread(SpreadData spreadData)
Method Detail

getActualStartDate

public Date getActualStartDate()
The earliest actual start date for this summarized assignment, or null if none of the assignments have started.

Returns:
the earliest actual start date for this summarized assignment

setActualStartDate

public void setActualStartDate(Date actualStartDate)
Sets the actual start date value for this summarized assignment.

Parameters:
actualStartDate - the actual start date for this assignment

getActualFinishDate

public Date getActualFinishDate()
The latest actual finish date for this summarized assignment, or null if any of the assignments have not finished.

Returns:
the latest actual finish date for this summarized assignment

setActualFinishDate

public void setActualFinishDate(Date actualFinishDate)
Sets the actual finish date value for this summarized assignment.

Parameters:
actualFinishDate - the actual finish date for this assignment

getRemainingStartDate

public Date getRemainingStartDate()
The earliest remaining start date for this summarized assignment, or null if all assignments have been completed.

Returns:
the earliest remaining start date for this summarized assignment

setRemainingStartDate

public void setRemainingStartDate(Date remainingStartDate)
Sets the remaining start date value for this summarized assignment.

Parameters:
remainingStartDate - the remaining start date for this summarized assignment

getRemainingFinishDate

public Date getRemainingFinishDate()
Returns the latest remaining finish date for this summarized assignment, or null if all assignments have been completed.

Returns:
the remaining finish date for this summarized assignment

setRemainingFinishDate

public void setRemainingFinishDate(Date remainingFinishDate)
Sets the remaining finish date value for this summarized assignment.

Parameters:
remainingFinishDate - the remaining finish date for this summarized assignment

getResourceType

public String getResourceType()
The resource type for this summarized assignment, possible values are:
  • LABOR for labor Resources
  • NONLABOR for non-labor Resources
  • MATERIAL for material Resources
  • null for Roles
  • Returns:
    the resource type for this summarized assignment

    setResourceType

    public void setResourceType(String resourceType)
    Sets the resource type for this summarized assignment, valid values are:
  • LABOR for labor Resources
  • NONLABOR for non-labor Resources
  • MATERIAL for material Resources
  • null for Roles
  • Parameters:
    resourceType - the resource type for this summarized assignment

    setFinancialPeriodIds

    public void setFinancialPeriodIds(Map<Date,ObjectId> financialPeriodIds)
    Sets the map that enables each SpreadPeriod to determine which financial period it corresponds to.

    Parameters:
    financialPeriodIds - map of Financial Period object IDs, keyed by the period's start date

    Primavera Integration API Release 8

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