GenericDocument

Description

Package: com.ibm.rpm.document.containers

Extends: DocumentElement

Usage

This object contains information common to all documents.

Supported API Calls

Security Restrictions

N/A

Fields

The following table lists the fields for this object.

Table 1. GenericDocument Field Description
Field Detail
attributeAssignments

Type: AttributeAssignment[]

Default value: N/A

Description: Attributes assigned to this document.

Field validation description: N/A

Additional field security restrictions: N/A

customFieldAssignments

Type:CustomFieldAssignment[]

Default value: N/A

Description: The CustomFieldAssignment list associated with the GenericDocument.

Field validation description: N/A

Additional field security restrictions: N/A

elementSecurityType

Type: ElementSecurityType

Default value: ProjectLevel

Description: 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.

Field validation description: N/A

Additional field security restrictions: N/A

locked

Type: boolean

Default value: false

Description: When a document has been checked out by a resource, it is available to other resources in read-only mode. Therefore, in the event that a document must be temporarily secured from all editing, the value of this field can be set to true. If the value of this field value is set to false, then the document is available for editing.

Field validation description: N/A

Additional field security restrictions: N/A

statusUpdates

Type: StatusUpdate[]

Default value: N/A

Description: Allows the user to update the status of each revision of the document by entering a change brief.

Field validation description: N/A

Additional field security restrictions: N/A

visibleAtParent

Type: boolean

Default value: true

Description: 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.

Field validation description: N/A

Additional field security restrictions: N/A

Inherited Fields

Click on object for list of inherited fields:

From RPMObject

From DocumentElement

Related Objects