com.ibm.rpm.contract.containers
Contract

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.contract.containers.GenericContract
   extended bycom.ibm.rpm.contract.containers.Contract

Contract
Extends: com.ibm.rpm.contract.containers.GenericContract
Child objects: None

Related scope: com.ibm.rpm.contract.scope.ContractScope

Parent is not mandatory, allowed parent type is ContractFolder.

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

ID

Field Summary
ContractChargeSchedule[] chargeSchedules
   The charging schedule of the customer.
ContractType contractType
   The type of the contract.
Currency currency
   The currency in which the contract will be paid.
xsd:string description
   The description of the contract
xsd:string externalReference
   The external references of the current contract.
xsd:double maximumAmount
   The maximum amount which can be charged for the current contract.

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 name of the object being created (Contract or Folder).
RPMObject parent
   The parent of the RPMObject.

Field Detail

chargeSchedules


ContractChargeSchedule[] chargeSchedules
The charging schedule of the customer.

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

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

Valid types:
com.ibm.rpm.contract.containers.ContractChargeSchedule

contractType


ContractType contractType
The type of the contract.

Null value: This field may never be null during updates.

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

Relationship: This field is a reference relationship.

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

currency


Currency currency
The currency in which the contract will be paid.

Null value: This field may never be null.

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

Relationship: This field is a reference relationship.

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

description


xsd:string  description
The description of the contract

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


externalReference


xsd:string  externalReference
The external references of the current contract.

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


maximumAmount


xsd:double  maximumAmount
The maximum amount which can be charged for the current contract.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9999999999999.99.

Default value: This default value is 0.


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 name of the object being created (Contract or Folder).

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.

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.contract.containers.ContractFolder