CustomField

Description

Package: com.ibm.rpm.customfield.containers

Extends: GenericCustomField

Usage

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

Security Restrictions

N/A

Fields

The following table lists the fields for this object.

Table 1. CustomField Field Description
Field Detail
datafieldCategory

Type: DatafieldCategory

Default value: null

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

Field validation description: Must be specified when it is a CustomDatafieldCategory (and hence its value is a CustomDatafield). Otherwise, it can be inferred from the type of the defaultValue, if the latter is specified.

Additional field security restrictions: N/A

defaultValue

Type: anyType

Default value: null

Description: The default value for all CustomFieldAssignment instances associated with this custom field.

Field validation description: Validation varies depending on the value attributed to inputType:

  • Text: string. Limit 400 characters.
  • Currency: double
  • Date: date
  • Numeric: integer
  • Checkbox: boolean
  • Datafield: Datafield. Must be a child of the specified datafieldCategory.

Additional field security restrictions: N/A

inputType

Type: FieldInputType

Default value: N/A

Description: The type of value that this custom field can contain (see defaultValue).

Field validation description: This field is mandatory.

Additional field security restrictions: N/A

securityGroup

Type: int

Default value: 0

Description: One of the predefined security groups.

Note: Not implemented in this release.

Field validation description: This field is mandatory on update.

Additional field security restrictions: N/A

Inherited Fields

Click on object for list of inherited fields:

From RPMObject

From GenericCustomField

Related Objects