Package com.primavera.common.value.spread

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 Type	Method	Description
Cost	getCost(String fieldName)	Gets the cost value of the specified field in this spread period.
Cost	getCumulativeCost(String fieldName)	Gets the cumulative cost value of the specified field in this spread period.
Unit	getCumulativeUnits(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.
Date	getSpreadPeriodEnd()	Gets the end time of this spread period.
Date	getSpreadPeriodStart()	Gets the start time of this spread period.
Unit	getUnits(String fieldName)	Gets the unit value of the specified field in this spread period.
void	setCost(String fieldName, Cost cost)	Sets the cost value of the specified field in this spread period.
void	setUnits(String fieldName, Unit units)	Sets 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

Unit getUnits(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(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(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(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(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(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