com.ibm.rpm.financial.containers
TimePhasedFinancial

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.financial.containers.TimePhasedFinancial

TimePhasedFinancial
Extends: com.ibm.rpm.framework.RPMObject
Child objects: None

Related scope: com.ibm.rpm.financial.scope.TimePhasedFinancialScope

TimePhasedFinancial captures the monthly breakdown of the financial values for WorkElement or Scope items.

A WBSFinancial or WorksheetFinancial object must first be created in order to create a TimePhasedFinancial object. TimePhasedFinancial is typically created, updated, and deleted from a WBSFinancial or WorksheetFinancial object perspective.

Parent is mandatory. Allowed parent types are WBSFinancial or WorksheetFinancial.

The checkout mode type is: Parent

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Field Summary
BudgetType budgetType
    The type of budget associated with this time phased information.
xsd:double month01Value
   The value for month 01.
xsd:double month02Value
   The Value for month 02.
xsd:double month03Value
   The Value for month 03.
xsd:double month04Value
   The Value for month 04.
xsd:double month05Value
   The Value for month 05.
xsd:double month06Value
   The Value for month 06.
xsd:double month07Value
   The Value for month 07.
xsd:double month08Value
   The Value for month 08.
xsd:double month09Value
   The Value for month 09.
xsd:double month10Value
   The Value for month 10.
xsd:double month11Value
    The Value for month 11.
xsd:double month12Value
   The Value for month 12.
xsd:double totalForYear
   Is the sum of the values for all the months that belong to the same Year. This field is read-only.
xsd:int year
   Represents the financial year that applies to this breakdown. This is field is read-only, unless object is created.

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
RPMObject parent
   The parent of the RPMObject.

Field Detail

budgetType


BudgetType budgetType
The type of budget associated with this time phased information.

Null value: This field may never be null.

Relationship: This field is a reference relationship.


month01Value


xsd:double  month01Value
The value for month 01.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month02Value


xsd:double  month02Value
The Value for month 02.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month03Value


xsd:double  month03Value
The Value for month 03.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month04Value


xsd:double  month04Value
The Value for month 04.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month05Value


xsd:double  month05Value
The Value for month 05.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month06Value


xsd:double  month06Value
The Value for month 06.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month07Value


xsd:double  month07Value
The Value for month 07.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month08Value


xsd:double  month08Value
The Value for month 08.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month09Value


xsd:double  month09Value
The Value for month 09.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month10Value


xsd:double  month10Value
The Value for month 10.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month11Value


xsd:double  month11Value
The Value for month 11.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


month12Value


xsd:double  month12Value
The Value for month 12.

Minimum: The minimum value for this field is -1e+13.

Maximum: The maximum value for this field is 1e+13.


totalForYear


xsd:double  totalForYear
Is the sum of the values for all the months that belong to the same Year. This field is read-only.

year


xsd:int  year
Represents the financial year that applies to this breakdown. This is field is read-only, unless object is created.

Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
The parent of the RPMObject.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.

Valid types:
com.ibm.rpm.financial.containers.AbstractFinancial