com.ibm.rpm.resource.containers
PoolModule

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.framework.containers.AbstractModule
   extended bycom.ibm.rpm.resource.containers.PoolModule

PoolModule
Extends: com.ibm.rpm.framework.containers.AbstractModule
Child objects: None

Related scope: com.ibm.rpm.resource.scope.PoolModuleScope

This module class is used to load all the relevant containers related to Pool.

Delete restrictions: This object can't be deleted.

Creation restrictions: This object may not be created. The database contains a fixed number of those objects that may be updated.

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
AttributeCategory[] attributeCategories
    List of all the pool attribute categories.
CompanySize[] companySizes
    List of valid company size datafields.
PoolDomain[] poolDomains
    List of all the valid pool domains.
Pool[] pools
    List containing all the first level pools in the application.

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

attributeCategories


AttributeCategory[] attributeCategories
List of all the pool attribute categories.

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

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


companySizes


CompanySize[] companySizes
List of valid company size datafields.

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

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


poolDomains


PoolDomain[] poolDomains
List of all the valid pool domains.

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

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


pools


Pool[] pools
List containing all the first level pools in the application.

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

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


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.

Relationship: This field is a reference relationship.

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