AbstractDocument

Description

Package: com.ibm.rpm.document.containers

Extends: GenericDocument

Usage

AbstractDocument is an abstract class.

Supported API Calls

Security Restrictions

N/A

Fields

The following table lists the fields for this object.

Table 1. AbstractDocument Field Description
Field Detail
elementNumber

Type: int

Default value: N/A

Description: The unique ID of the document. This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

keywords

Type: string

Default value: N/A

Description: Keywords that can be used for future document searches.

Field validation description: Limit 255 characters.

Additional field security restrictions: N/A

majorRevisionNumber

Type: int

Default value: N/A

Description: Each checkin action increments the minor revision number by 1. When the minor revision number reaches 99, the next checkin action sets it to 0 and the major revision number is incremented by 1. The document’s actual revision number is the major revision and the minor revision numbers seperated by a period. This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

minorRevisionNumber

Type: int

Default value: N/A

Description: Each checkin action increments the minor revision number by 1. When the minor revision number reaches 99, the next checkin action sets it to 0 and the major revision number is incremented by 1. The document’s actual revision number is the major revision and the minor revision numbers seperated by a period. This field is read-only.

Field validation description: N/A

Additional field security restrictions: N/A

published

Type: PublishedType

Default value: None

Description: Determines if the document is published to the team, to a template, or not at all.

Field validation description: N/A

Additional field security restrictions: N/A

referenceNumber

Type: string

Default value: N/A

Description: A reference number for the document.

Field validation description: Limit 50 characters.

Additional field security restrictions: N/A

state

Type: DocumentState

Default value: The DocumentState containing the name field with the value ‘1’.

Description: The current state of the document.

Field validation description: N/A

Additional field security restrictions: N/A

summary

Type: string

Default value: N/A

Description: A summary of the document’s contents.

Field validation description: Limit 1024 characters.

Additional field security restrictions: N/A

Inherited Fields

Click on object for list of inherited fields:

From RPMObject

From DocumentElement

From GenericDocument

Related Objects