Skip to main content

Functions Accessible via 'DocumentVO'

Updated over 3 weeks ago

1

getAttachedFileName

Signature: getAttachedFileName()

Description: To get the attached file name.

Returns: [String] - Attached file name

2

getCustomAttributes

Signature: getCustomAttributes()

Description: To get custom attributes of the revision.

Returns: List<CustomAttributeVO>

3

getDocRef

Signature: getDocRef()

Description: To get the document reference of the revision.

Returns: [String] - DocRef

4

getDocTitle

Signature: getDocTitle()

Description: To get the document title of the revision.

Returns: [String] - Document Title

5

getFileName

Signature: getFileName()

Description: To get the file name of the revision.

Returns: [String] - File name

6

getFileSize

Signature: getFileSize()

Description: To get the file size of the revision.

Returns: [long] - File size in bytes

7

getHasAttachment

Signature: getHasAttachment()

Description: To get details of whether the revision has an attachment (True = the revision has an attachment, False = the revision has no attachments).

Returns: [True/False] - Has attachment flag

8

getPublishDate

Signature: getPublishDate()

Description: To get the publish date of the revision.

Returns: [String] - Document publish date

9

getPublisherEmail

Signature: getPublisherEmail()

Description: To get publisher email.

Returns: [String] - Document publisher email

10

getPurposeOfIssue

Signature: getPurposeOfIssue()

Description: To get the 'purpose of issue' of the revision.

Returns: [String] - Purpose of issue

11

getPoiAbbreviation

Signature: getPoiAbbreviation()

Description: To get an abbreviation of POI

Returns: [String] - Abbreviation of Purpose of issue

12

getRevision

Signature: getRevision()

Description: To get the revision number of the revision.

Returns: [String] - Revision

13

getRevisionNotes

Signature: getRevisionNotes()

Description: To get notes specific to the revision.

Returns: [String] - Revision notes

14

getStatus

Signature: getStatus()

Description: To get the status of the revision.

Returns: [String] - Status

15

isPrivate

Signature: isPrivate()

Description: To get file privacy flag (True = Private, False = Public)

Returns: [True/False] - File privacy

16

setDocTitle

Signature: setDocTitle(String docTitle)

Description: To set the document title of the revision.

Returns: [True/False] - Document title

17

setRevision

Signature: setRevision(String revision)

Description: To set the revision number of the revision.

Returns: ---

18

setResponseMessage

Signature: setResponseMessage(String responseMessage)

Description: To set the response message to display on the user interface when validation via Groovy script is failed. It should only be used in the Groovy script configured with the 'Pre' mode type trigger.

Returns: ---

19

setRevisionNotes

Signature: setRevisionNotes(String revisionNotes)

Description: To set revision notes of the revision.

Returns: ---

20

setResponseStatus

Signature: setResponseStatus(boolean true/false)

Description: To set response status 'true'/'false'. Used for validation in Groovy script configured with 'Pre' mode type trigger. Usually, it can be used to set validation failed with false.

Returns: ---

21

getStatusAbbreviation

Signature: getStatusAbbreviation()

Description: To get an abbreviation of Status

Returns: [String] - Abbreviation of Status



Did this answer your question?