com.ibm.rpm.customfield.containers
CustomFieldAssignment

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.customfield.containers.CustomFieldAssignment

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

Related scope: com.ibm.rpm.framework.RPMObjectScope

A CustomFieldAssignment is used to assign a custom field to a particular project, deliverable, task, scope element, document, resource, client cost center, or asset. CustomFieldAssignment is always loaded with both its parent and related CustomField objects.

Calling 'delete' on this object will cause it to switch to the default value.

Parent is mandatory, allowed parent values are work element, scope, document, asset, resource and clientcostcenter.

A CustomFieldAssignment must never be created manually.

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
CustomField customField
   Defines the domain of valid values which can be assigned.
java.lang.Object value
   Defines the value of the custom field for this particular assignment.

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

customField


CustomField customField
Defines the domain of valid values which can be assigned.

Null value: This field may never be null.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.


value


java.lang.Object  value
Defines the value of the custom field for this particular assignment.

Validation:

May be null. The validation is dependant on the value of inputType.

The valid types are dependent on the input type.

Valid types:
xsd:boolean
xsd:double
xsd:dateTime
xsd:int
xsd:string
com.ibm.rpm.applicationadministration.containers.Datafield

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.asset.containers.Asset
com.ibm.rpm.clientcostcenters.containers.ClientCostCenter
com.ibm.rpm.document.containers.GenericDocument
com.ibm.rpm.resource.containers.Resource
com.ibm.rpm.scopemanagement.containers.ScopeElement
com.ibm.rpm.wbs.containers.WorkElement