com.ibm.rpm.customfield.containers
CustomField

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.customfield.containers.GenericCustomField
   extended bycom.ibm.rpm.customfield.containers.CustomField

CustomField
Extends: com.ibm.rpm.customfield.containers.GenericCustomField
Child objects: None

Related scope: com.ibm.rpm.customfield.scope.CustomFieldScope

A CustomField represent an organization-defined (or user-defined) field to be used within Rational Portfolio Manager. It is assigned to projects, deliverables, tasks, scope elements, documents, resources, clients, or assets through the intermediate class CustomFieldAssignment.

Parent is mandatory, allowed parent value is CustomFieldCategory

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
DatafieldCategory datafieldCategory
   Defines the domain of valid values for this custom field, when the value of inputType is set to Datafield.
java.lang.Object defaultValue
   The default value for all CustomFieldAssignment instances associated with this custom field.
FieldInputType inputType
   The type of value that this custom field can contain (see defaultValue).
xsd:int securityGroup
   One of the predefined security groups. Not implemented in this release.

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 custom field.
RPMObject parent
   The parent of the RPMObject.

Field Detail

datafieldCategory


DatafieldCategory datafieldCategory
Defines the domain of valid values for this custom field, when the value of inputType is set to Datafield.

Relationship: This field is a reference relationship.


defaultValue


java.lang.Object  defaultValue
The default value for all CustomFieldAssignment instances associated with this custom field.

Validation:

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

The valid types are dependent on the input type.


inputType


FieldInputType inputType
The type of value that this custom field can contain (see defaultValue).

Null value: This field may never be null.

Relationship: This field is a reference relationship.


securityGroup


xsd:int  securityGroup
One of the predefined security groups. Not implemented in this release.

Null value: This field may never be null during updates.


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 custom field.

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


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.customfield.containers.CustomFieldCategory