com.ibm.rpm.applicationadministration.containers
AdministrationModule

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.framework.containers.AbstractModule
   extended bycom.ibm.rpm.applicationadministration.containers.AdministrationModule

AdministrationModule
Extends: com.ibm.rpm.framework.containers.AbstractModule
Child objects: None

Related scope: com.ibm.rpm.applicationadministration.scope.AdministrationModuleScope

This module class is used to load all relevant containers related to ApplicationAdministration.

Delete restrictions: This object can't be deleted.

Creation restrictions: This object may not be created. The database contains a fixed number of those objects that may be updated.

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

ID

Field Summary
Currency[] currencies
    List of currencies in the application.
DatafieldCategory[] datafieldCategories
    List of all the datafield categories in the application.
Geographical[] geographicals
    List of the root geographical objects in the application.
Organizational[] organizationals
    List of the root organizational objects in the application.
RPMCalendar[] rpmCalendars
    List of the root calendars in the application.

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

currencies


Currency[] currencies
List of currencies in the application.

Scoping: This field will be used by the API if the scope field currencies 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.Currency

datafieldCategories


DatafieldCategory[] datafieldCategories
List of all the datafield categories in the application.

Scoping: This field will be used by the API if the scope field datafieldCategories 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.CustomDatafieldCategory

geographicals


Geographical[] geographicals
List of the root geographical objects in the application.

Scoping: This field will be used by the API if the scope field geographicals 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.Region
com.ibm.rpm.applicationadministration.containers.Country

organizationals


Organizational[] organizationals
List of the root organizational objects in the application.

Scoping: This field will be used by the API if the scope field organizationals 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.Organization

rpmCalendars


RPMCalendar[] rpmCalendars
List of the root calendars in the application.

Scoping: This field will be used by the API if the scope field rpmCalendars 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.RPMCalendar

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.