com.ibm.rpm.resource.containers
PoolReference

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.resource.containers.PoolReference

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

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

Represents the reference of a Pool.

Parent is mandatory, allowed parent type is Pool.

The checkout mode type is: Parent

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
CompanySize companySize
    Company size of the referenced pool.
xsd:string contactEmail
   The e-mail address of the reference.
xsd:string contactFax
   The fax number of the reference.
xsd:string contactName
   The name of the reference.
xsd:string contactTelephone
   The telephone number of the reference.
xsd:string organizationAddress
    Address of the organization referenced by this pool.
xsd:string organizationFax
   The organization fax number of the reference.
xsd:string organizationName
   The organization name of the reference.
xsd:string organizationTelephone
   The organization telephone number of the reference.
xsd:string organizationWebsite
   The organization website of the reference.

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

companySize


CompanySize companySize
Company size of the referenced pool.

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

Relationship: This field is a reference relationship.

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

contactEmail


xsd:string  contactEmail
The e-mail address of the reference.

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

Validation: The field must contain a valid e-mail address.


contactFax


xsd:string  contactFax
The fax number of the reference.

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

Validation: The field must contain a valid telephone number.


contactName


xsd:string  contactName
The name of the reference.

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


contactTelephone


xsd:string  contactTelephone
The telephone number of the reference.

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

Validation: The field must contain a valid telephone number.


organizationAddress


xsd:string  organizationAddress
Address of the organization referenced by this pool.

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


organizationFax


xsd:string  organizationFax
The organization fax number of the reference.

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

Validation: The field must contain a valid telephone number.


organizationName


xsd:string  organizationName
The organization name of the reference.

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


organizationTelephone


xsd:string  organizationTelephone
The organization telephone number of the reference.

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

Validation: The field must contain a valid telephone number.


organizationWebsite


xsd:string  organizationWebsite
The organization website of the reference.

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

Validation: The field must contain a valid URL.


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.

Null value: This field may never be null.

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.resource.containers.Pool