com.ibm.rpm.financial.containers
ChargeCodeCategory

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.financial.containers.GenericChargeCode
   extended bycom.ibm.rpm.financial.containers.ChargeCodeCategory

ChargeCodeCategory
Extends: com.ibm.rpm.financial.containers.GenericChargeCode
Child objects: None

Related scope: com.ibm.rpm.financial.scope.ChargeCodeScope

A ChargeCodeCategory represents a charge code category (folder). It can contain either charge code categories or charge codes.

Parent is not mandatory, allowed parent type is ChargeCodeCategory. In the case that no parent is associated, the ChargeCodeCategory is a root category.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Rules to delete: The object is deletable only if it doesn't have a external ID.

Field Summary
GenericChargeCode[] children
   A charge code category contains children charge codes or charge code categories.

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 description
   Detailed description of the charge code.
xsd:string externalID
   The identifier used to reference an external system.
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
   Name of the charge code or charge code category, as displayed in the RPM client.
RPMObject parent
   The parent of the RPMObject.

Field Detail

children


GenericChargeCode[] children
A charge code category contains children charge codes or charge code categories.

Scoping: This field will be used by the API if the scope field children 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.financial.containers.ChargeCode

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.


description


xsd:string  description
Detailed description of the charge code.

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


externalID


xsd:string  externalID
The identifier used to reference an external system.

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


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
Name of the charge code or charge code category, as displayed in the RPM client.

Minimum: The minimum length for this field is 1 characters.

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

Null value: This field may never be null.


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.financial.containers.ChargeCodeCategory
com.ibm.rpm.financial.containers.FinancialModule