com.ibm.rpm.document.containers
GenericDocument

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.document.containers.DocumentElement
   extended bycom.ibm.rpm.document.containers.GenericDocument

GenericDocument
Extends: com.ibm.rpm.document.containers.DocumentElement
Child objects:
   com.ibm.rpm.document.containers.AbstractDocument
   com.ibm.rpm.document.containers.DelDoc
   com.ibm.rpm.document.containers.Document
   com.ibm.rpm.document.containers.NoteMinutes
   com.ibm.rpm.document.containers.Software
   com.ibm.rpm.document.containers.UrlDocument
   com.ibm.rpm.document.containers.WPDoc

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

This object contains information common to all documents.

The checkout mode type is: Self

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

ID

Field Summary
AttributeAssignment[] attributeAssignments
   Attributes assigned to this document.
Resource author
   The resource who originally added the document to IBM Rational Portfolio Manager.
xsd:string checkoutFolder
   The full path to where the Document is checked out.
xsd:dateTime creationDate
   Represents the date when the document was created.
CustomFieldAssignment[] customFieldAssignments
   The CustomFieldAssignment list associated with the GenericDocument.
DocumentBlobDetails documentBlobDetails
   The name of the file(or URL) stored in the database. This field is always loaded for all documents
xsd:int documentCompressedSize
   The compressed size of the document in kilobytes
xsd:int documentSize
   The size of the document in kilobytes
DocumentStatusType documentStatus
   This field indicates the intrinsic status of the document as seen by the system.
xsd:int elementNumber
   The unique ID of the document. This field is read-only.
ElementSecurityType elementSecurityType
   The Element Security feature provides the document creator with the ability to allow access at Project Level to documents or to restrict access to specific documents By Invitation.
xsd:boolean hasAttachment
   Indicates if the element has an attachment.
xsd:string hostName
   The name of the machine where the document is checked out.
Resource lastCheckedOutBy
   A reference to the resource that last checked out the document.
xsd:dateTime lastUpdated
   Represents the date when the document was last updated.
xsd:boolean locked
   This field is readonly, cannot be set or unset directly.When value of this field is true then the document is temporarily secured or locked from all editing. To lock the document, lockDocument API should be used.When false, then the document is available for editing. To Unlock the document unLockDocument API should be used.
xsd:string parentSortingRank
   The rank of this element's parent.
StatusUpdate[] statusUpdates
   Allows the user to update the status of each revision of the document by entering a change brief.
xsd:string templateSortingRank
   The rank of this element's template (if any).
xsd:boolean visibleAtParent
   When the value of this field is set to false, the document is prevented from rolling up to its immediate parent and all parents above. If this value of this field is true, then the document can be seen from any of its parents.
xsd:string wbsSortingRank
   The rank of the current element in the WBS.
xsd:dateTime workflowCollaborationDate
   The date of the current workflow process
AvailableWorkflowProcess[] workflowProcessesAvailable
   List of available WorkflowProcesses for this GenericDocument.
RunningWorkflowProcess[] workflowProcessesRunning
   List of running WorkflowProcesses for this GenericDocument.

Inherited Field Summary
xsd:string assignedResources
   A list of all the names of the resources assigned to this document
DocumentElement[] children
   The children documents or folders.
GenericProject containingProject
   The containing project from the WBS section if any.
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 documentRank
   Indicates whether the document has a rank assigned to it or not. If it is assigned a rank, then "Y" will be returned. "N" otherwise.
RPMObject externalParent
   The external parent depending on the module it belongs to. For example WBS (Proposal, Deliverable), Client (ClientCostCenter)
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 document or folder.
RPMObject parent
   The parent of the RPMObject.
xsd:string parentSortingRank
   Returns the rank of this document's parent element, which can be used for sorting.
ResourceRoleAssignment[] resourceAssignments
   The list of resources assigned to this document.
xsd:string templateSortingRank
   Returns the rank of the template associated to this document element, which can be used for sorting.
xsd:string wbsSortingRank
   Returns the rank of this document element, which can be used for sorting.

Field Detail

attributeAssignments


AttributeAssignment[] attributeAssignments
Attributes assigned to this document.

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

author


Resource author
The resource who originally added the document to IBM Rational Portfolio Manager.

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

Relationship: This field is a reference relationship.


checkoutFolder


xsd:string  checkoutFolder
The full path to where the Document is checked out.

Read-only behavior: The value of this field is read only.


creationDate


xsd:dateTime  creationDate
Represents the date when the document was created.

Read-only behavior: The value of this field is read only.

Validation: The year, month and day values will be used by this field.


customFieldAssignments


CustomFieldAssignment[] customFieldAssignments
The CustomFieldAssignment list associated with the GenericDocument.

Scoping: This field will be used by the API if the scope field customFieldAssignments 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.customfield.containers.CustomFieldAssignment

documentBlobDetails


DocumentBlobDetails documentBlobDetails
The name of the file(or URL) stored in the database. This field is always loaded for all documents

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

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


documentCompressedSize


xsd:int  documentCompressedSize
The compressed size of the document in kilobytes

Read-only behavior: The value of this field is read only.


documentSize


xsd:int  documentSize
The size of the document in kilobytes

Read-only behavior: The value of this field is read only.


documentStatus


DocumentStatusType documentStatus
This field indicates the intrinsic status of the document as seen by the system.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


elementNumber


xsd:int  elementNumber
The unique ID of the document. This field is read-only.

Read-only behavior: The value of this field is read only.


elementSecurityType


ElementSecurityType elementSecurityType
The Element Security feature provides the document creator with the ability to allow access at Project Level to documents or to restrict access to specific documents By Invitation.

Relationship: This field is a reference relationship.


hasAttachment


xsd:boolean  hasAttachment
Indicates if the element has an attachment.

Read-only behavior: The value of this field is read only.


hostName


xsd:string  hostName
The name of the machine where the document is checked out.

Read-only behavior: The value of this field is read only.


lastCheckedOutBy


Resource lastCheckedOutBy
A reference to the resource that last checked out the document.

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

Relationship: This field is a reference relationship.


lastUpdated


xsd:dateTime  lastUpdated
Represents the date when the document was last updated.

Read-only behavior: The value of this field is read only.

Validation: The year, month, day, hour, minutes and seconds values will be used by this field.


locked


xsd:boolean  locked
This field is readonly, cannot be set or unset directly.When value of this field is true then the document is temporarily secured or locked from all editing. To lock the document, lockDocument API should be used.When false, then the document is available for editing. To Unlock the document unLockDocument API should be used.

Read-only behavior: The value of this field is read only.


parentSortingRank


xsd:string  parentSortingRank
The rank of this element's parent.

Read-only behavior: The value of this field is read only.


statusUpdates


StatusUpdate[] statusUpdates
Allows the user to update the status of each revision of the document by entering a change brief.

Read-only behavior: The value of this field is read only.

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


templateSortingRank


xsd:string  templateSortingRank
The rank of this element's template (if any).

Read-only behavior: The value of this field is read only.


visibleAtParent


xsd:boolean  visibleAtParent
When the value of this field is set to false, the document is prevented from rolling up to its immediate parent and all parents above. If this value of this field is true, then the document can be seen from any of its parents.

wbsSortingRank


xsd:string  wbsSortingRank
The rank of the current element in the WBS.

Read-only behavior: The value of this field is read only.


workflowCollaborationDate


xsd:dateTime  workflowCollaborationDate
The date of the current workflow process

Read-only behavior: The value of this field is read only.

Validation: The year, month, day, hour, minutes and seconds values will be used by this field.


workflowProcessesAvailable


AvailableWorkflowProcess[] workflowProcessesAvailable
List of available WorkflowProcesses for this GenericDocument.

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

Read-only behavior: The value of this field is read only.

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


workflowProcessesRunning


RunningWorkflowProcess[] workflowProcessesRunning
List of running WorkflowProcesses for this GenericDocument.

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

Read-only behavior: The value of this field is read only.

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


Inherited Field Detail

assignedResources


xsd:string  assignedResources
A list of all the names of the resources assigned to this document

Read-only behavior: The value of this field is read only.


children


DocumentElement[] children
The children documents or folders.

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.


containingProject


GenericProject containingProject
The containing project from the WBS section if any.

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

Relationship: This field is a reference relationship.


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.


documentRank


xsd:string  documentRank
Indicates whether the document has a rank assigned to it or not. If it is assigned a rank, then "Y" will be returned. "N" otherwise.

Read-only behavior: The value of this field is read only.


externalParent


RPMObject externalParent
The external parent depending on the module it belongs to. For example WBS (Proposal, Deliverable), Client (ClientCostCenter)

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

Relationship: This field is a reference relationship.


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 document or folder.

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


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.

Valid types:
com.ibm.rpm.document.containers.DelDoc
com.ibm.rpm.document.containers.Document
com.ibm.rpm.document.containers.DocumentFolder
com.ibm.rpm.document.containers.NoteMinutes
com.ibm.rpm.document.containers.Software
com.ibm.rpm.document.containers.UrlDocument
com.ibm.rpm.document.containers.WPDoc

parentSortingRank


xsd:string  parentSortingRank
Returns the rank of this document's parent element, which can be used for sorting.

Read-only behavior: The value of this field is read only.


resourceAssignments


ResourceRoleAssignment[] resourceAssignments
The list of resources assigned to this document.

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

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


templateSortingRank


xsd:string  templateSortingRank
Returns the rank of the template associated to this document element, which can be used for sorting.

Read-only behavior: The value of this field is read only.


wbsSortingRank


xsd:string  wbsSortingRank
Returns the rank of this document element, which can be used for sorting.

Read-only behavior: The value of this field is read only.