com.ibm.rpm.applicationadministration.containers
Currency

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.applicationadministration.containers.GenericDatafield
   extended bycom.ibm.rpm.applicationadministration.containers.Datafield
    extended bycom.ibm.rpm.applicationadministration.containers.Currency

Currency
Extends: com.ibm.rpm.applicationadministration.containers.Datafield
Child objects: None

Related scope: com.ibm.rpm.framework.RPMObjectScope

Represents currencies which can be assigned to resources and projects.

Currencies are a datafield type, therefore, they cannot be deleted.

Historical data of the exchange rate is kept at the exchangeRanges array level (refer to, CurrencyExchangeRange).

It is mandatory that the value of the parent field be set to null.

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

ID

Related code samples :

Java

C#

Field Summary
CurrencyExchangeRange[] exchangeRanges
   The array of currency exchange ranges. It represents the historical information of the currency.
xsd:double exchangeRate
   The current exchange rate of this currency.

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.
xsd:string name
   The currency name.
RPMObject parent
   The parent of the RPMObject.

Field Detail

exchangeRanges


CurrencyExchangeRange[] exchangeRanges
The array of currency exchange ranges. It represents the historical information of the currency.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.

Valid types:
com.ibm.rpm.applicationadministration.containers.CurrencyExchangeRange

exchangeRate


xsd:double  exchangeRate
The current exchange rate of this currency.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 9999999999999.99.

Null value: This field may never be null.


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.


name


xsd:string  name
The currency name.

Minimum: The minimum length for this field is 1 characters.

Maximum: The maximum length for this field is 50 characters.

Null value: This field may never be null.


parent


RPMObject parent
The parent of the RPMObject.

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

Scoping during creation: This field is always in scope at creation time.

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

Relationship: This field is a reference relationship.

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

Valid types:
com.ibm.rpm.applicationadministration.containers.AdministrationModule