com.ibm.rpm.contract.containers
ContractFolder

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

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

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

ContractFolder represents the folder that contains all contracts for a customer.

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
GenericContract[] children
    List of child generic contract objects.

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

children


GenericContract[] children
List of child generic contract objects.

Scoping: This field will be used by the API if the scope field children 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.Contract
com.ibm.rpm.contract.containers.ContractFolder

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
com.ibm.rpm.contract.containers.ContractModule