FRAMES NO FRAMES |
com.ibm.rpm.framework.RPMObjectcom.ibm.rpm.document.containers.DocumentElement
com.ibm.rpm.document.containers.GenericDocument
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: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 |
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 |
RunningWorkflowProcess[]
|
workflowProcessesRunning
List of running |
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 |
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.
Scoping: This field will be used by the API if the scope field author is enabled.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Validation: The year, month and day values will be used by this field.
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.
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.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Scoping: This field will be used by the API if the scope field lastCheckedOutBy is enabled.
Relationship: This field is a reference relationship.
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.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
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.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
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.
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.
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 |
Read-only behavior: The value of this field is read only.
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.
Scoping: This field will be used by the API if the scope field containingProject is enabled.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
Scoping: This field will be used by the API if the scope field externalParent is enabled.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
Maximum: The maximum length for this field is 255 characters.
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.
Read-only behavior: The value of this field is read only.
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.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.