com.ibm.rpm.document.containers
DocumentFolder

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

DocumentFolder
Extends: com.ibm.rpm.document.containers.DocumentElement
Child objects: None

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

DocumentFolder is used to group documents.

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

ID

Related code samples :

Java

C#

Field Summary
xsd:boolean privateFolder
   This flag indicates if the folder is private or not.

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

privateFolder


xsd:boolean  privateFolder
This flag indicates if the folder is private or not.

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.scopemanagement.containers.AbstractScope
com.ibm.rpm.asset.containers.Asset
com.ibm.rpm.clientcostcenters.containers.ClientCostCenter
com.ibm.rpm.document.containers.DocumentFolder
com.ibm.rpm.resource.containers.Pool
com.ibm.rpm.resource.containers.Resource
com.ibm.rpm.wbs.containers.WorkElement

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.