com.ibm.rpm.document.containers
DocumentModule

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.framework.containers.AbstractModule
   extended bycom.ibm.rpm.document.containers.DocumentModule

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

Related scope: com.ibm.rpm.document.scope.DocumentModuleScope

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

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

ID

Field Summary
AttributeCategory[] attributeCategories
   TBD
CustomFieldCategory[] customFieldCategories
   TBD
DocumentState[] documentStates
   TBD
NoteMinutesRTF[] noteMinutesRtfs
   TBD
NoteState[] noteStates
   TBD

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

attributeCategories


AttributeCategory[] attributeCategories
TBD

Scoping: This field will be used by the API if the scope field attributeCategories is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


customFieldCategories


CustomFieldCategory[] customFieldCategories
TBD

Scoping: This field will be used by the API if the scope field customFieldCategories is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


documentStates


DocumentState[] documentStates
TBD

Scoping: This field will be used by the API if the scope field documentStates is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


noteMinutesRtfs


NoteMinutesRTF[] noteMinutesRtfs
TBD

Scoping: This field will be used by the API if the scope field noteMinutesRtfs is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


noteStates


NoteState[] noteStates
TBD

Scoping: This field will be used by the API if the scope field noteStates is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


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.

Scoping during creation: This field is always in scope at creation time.

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.