com.ibm.rpm.resource.containers
Pool

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

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

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

A Resource Pool is a logical grouping of resources that can be grouped by similar competencies or geographical locations. Resource Pools are also used for matrix-oriented organizations which allow Resource Managers to manage resources across departmental boundaries.

Zero or many resources can be assigned to a Pool. When deleting a Pool all contained Resource objects are also deleted. If a Pool contains a Resource that has been assigned an effort, it cannot be deleted.

Parent is not mandatory, allowed parent type is Pool.

The checkout mode type is: Self

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
xsd:string address
   The address of the company.
DefaultAdministrativeTask[] administrativeTasks
   The administrative tasks of the Pool.
AttributeAssignment[] attributeAssignments
   Each instance of AttributeAssignment keeps a pointer to an assigned PoolAttribute.
ClientCostCenter clientCostCenter
   The client/cost center that is assigned to the Pool.
xsd:string companyBackground
   The background of the company.
xsd:string contactName
   The contact name of the company.
xsd:string description
   The description of the Pool.
DocumentFolder documentFolder
   The documents that are associated to the Pool.
PoolDomain domain
   The domain of the Pool.
xsd:string email
   The e-mail address of the company contact.
xsd:string fax
   The fax number of the company contact.
xsd:string industriesServed
   The industries that the Pool serves.
xsd:string locationsServed
   The locations that are served by the Pool.
xsd:boolean maskEmployeeInfo
   If this field is true, the Employee Code of Resources belonging to this Pool is hidden and cannot be modified.
xsd:string name
   The name of the pool.
xsd:string organizationName
   The name of the organization.
xsd:string ownership
   The ownership of the Pool.
PoolReference[] poolReferences
    The list of pools that are referenced by this one.
Pool[] pools
   List of children Pool.
xsd:string productsExpertiseUsed
   A highlight of the major projects and product expertise that are used by the resources belonging to the Pool.
xsd:boolean publish
   If the field is true, the pool is published and all users who have Staff Acquisition access can search against the resources in the Pool. If the field is false, the pool is available only to the pool participants.
ResourceRoleAssignment[] resourceAssignments
   Used to identify and assign pool management resources. Allows management resources to view, search, and assign from the pool.
Resource[] resources
   The resources in the Pool.
SecurityGroup securityGroup
   The security group of the Pool.
xsd:string servicesOffered
   The services offered by the Pool.
xsd:string servicesSpecialized
   The services in which the Pool specializes.
xsd:string telephone
   The telephone number of the company contact

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

address


xsd:string  address
The address of the company.

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


administrativeTasks


DefaultAdministrativeTask[] administrativeTasks
The administrative tasks of the Pool.

Scoping: This field will be used by the API if the scope field administrativeTasks 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.timesheet.containers.AdministrativeTaskAssignment

attributeAssignments


AttributeAssignment[] attributeAssignments
Each instance of AttributeAssignment keeps a pointer to an assigned PoolAttribute.

Scoping: This field will be used by the API if the scope field attributeAssignments 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.applicationadministration.containers.AttributeAssignment

clientCostCenter


ClientCostCenter clientCostCenter
The client/cost center that is assigned to the Pool.

Relationship: This field is a reference relationship.

Valid types:
com.ibm.rpm.clientcostcenters.containers.ClientCostCenter

companyBackground


xsd:string  companyBackground
The background of the company.

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


contactName


xsd:string  contactName
The contact name of the company.

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


description


xsd:string  description
The description of the Pool.

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


documentFolder


DocumentFolder documentFolder
The documents that are associated to the Pool.

Scoping: This field will be used by the API if the scope field documentFolder 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.document.containers.DocumentFolder

domain


PoolDomain domain
The domain of the Pool.

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

Relationship: This field is a reference relationship.

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

email


xsd:string  email
The e-mail address of the company contact.

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

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


fax


xsd:string  fax
The fax number of the company contact.

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

Validation: The field must contain a valid telephone number.


industriesServed


xsd:string  industriesServed
The industries that the Pool serves.

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


locationsServed


xsd:string  locationsServed
The locations that are served by the Pool.

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


maskEmployeeInfo


xsd:boolean  maskEmployeeInfo
If this field is true, the Employee Code of Resources belonging to this Pool is hidden and cannot be modified.

name


xsd:string  name
The name of the pool.

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


organizationName


xsd:string  organizationName
The name of the organization.

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


ownership


xsd:string  ownership
The ownership of the Pool.

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


poolReferences


PoolReference[] poolReferences
The list of pools that are referenced by this one.

Scoping: This field will be used by the API if the scope field poolReferences 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.resource.containers.PoolReference

pools


Pool[] pools
List of children Pool.

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.

Valid types:
com.ibm.rpm.resource.containers.Pool

productsExpertiseUsed


xsd:string  productsExpertiseUsed
A highlight of the major projects and product expertise that are used by the resources belonging to the Pool.

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


publish


xsd:boolean  publish
If the field is true, the pool is published and all users who have Staff Acquisition access can search against the resources in the Pool. If the field is false, the pool is available only to the pool participants.

resourceAssignments


ResourceRoleAssignment[] resourceAssignments
Used to identify and assign pool management resources. Allows management resources to view, search, and assign from the pool.

Scoping: This field will be used by the API if the scope field resourceAssignments 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.resource.containers.ResourceRoleAssignment

resources


Resource[] resources
The resources in the Pool.

Scoping: This field will be used by the API if the scope field resources 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.resource.containers.Resource

securityGroup


SecurityGroup securityGroup
The security group of the Pool.

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

Relationship: This field is a reference relationship.

Valid types:
com.ibm.rpm.security.containers.SecurityGroup

servicesOffered


xsd:string  servicesOffered
The services offered by the Pool.

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


servicesSpecialized


xsd:string  servicesSpecialized
The services in which the Pool specializes.

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


telephone


xsd:string  telephone
The telephone number of the company contact

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

Validation: The field must contain a valid telephone number.


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 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