Primavera Integration API 7.0

com.primavera.common.value.spread
Interface SpreadPeriod

All Known Subinterfaces:
ActivitySpreadPeriod, EPSSpreadPeriod, ProjectResourceRoleSpreadPeriod, ProjectSpreadPeriod, ResourceAssignmentSpreadPeriod, com.primavera.common.value.spread.ResourceAssignmentSpreadPeriodBase, WBSSpreadPeriod

public interface SpreadPeriod

The base class of all spread period interfaces


Method Summary
 Cost getCost(java.lang.String fieldName)
          Gets the cost value of the specified field in this spread period
 Cost getCumulativeCost(java.lang.String fieldName)
          Gets the cumulative cost value of the specified field in this spread period
 Unit getCumulativeUnits(java.lang.String fieldName)
          Gets the cumulative unit value of the specified field in this spread period
 int getSpreadBucketType()
          Gets the bucket type of this spread period.
 SpreadBucketType getSpreadBucketTypeEnum()
          Gets the bucket type of this spread period in enum.
 java.util.Date getSpreadPeriodEnd()
          Gets the end time of this spread period.
 java.util.Date getSpreadPeriodStart()
          Gets the start time of this spread period.
 Unit getUnits(java.lang.String fieldName)
          Gets the unit value of the specified field in this spread period
 void setCost(java.lang.String fieldName, Cost cost)
          Sets the cost value of the specified field in this spread period
 void setUnits(java.lang.String fieldName, Unit units)
          Sets the unit value of the specified field in this spread period
 

Method Detail

getSpreadPeriodStart

java.util.Date getSpreadPeriodStart()
Gets the start time of this spread period.

Returns:
the start time of this spread period

getSpreadPeriodEnd

java.util.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

Unit getUnits(java.lang.String fieldName)
              throws SpreadFieldNotFoundException
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

Cost getCost(java.lang.String fieldName)
             throws SpreadFieldNotFoundException
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(java.lang.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 loaded
SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded

getCumulativeCost

Cost getCumulativeCost(java.lang.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 loaded
SpreadCumulativeDataNotLoadedException - if cumulative data was not loaded

setUnits

void setUnits(java.lang.String fieldName,
              Unit units)
              throws SpreadFieldNotFoundException,
                     SpreadNonEditableException
Sets the unit value of the specified field in this spread period

Parameters:
fieldName - the spread field name
units - the new unit value of the spread field
Throws:
SpreadFieldNotFoundException - if the unit field was not found
SpreadNonEditableException - if the unit field is not editable

setCost

void setCost(java.lang.String fieldName,
             Cost cost)
             throws SpreadFieldNotFoundException,
                    SpreadNonEditableException
Sets the cost value of the specified field in this spread period

Parameters:
fieldName - the spread field name
cost - the new cost value of the spread field
Throws:
SpreadFieldNotFoundException - if the cost field was not found
SpreadNonEditableException - if the cost field is not editable

Primavera Integration API 7.0

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