Skip to main content

Functions Accessible via 'placeholderService'

Updated over a month ago

1

getPlaceholderDetails

Signature: getPlaceholderDetails() Description: Retrieves placeholder details and populates a DocumentVO object by delegating to the internal DocumentContext.
Returns: DocumentVO - A DocumentVO object containing the placeholder details.

2

distributePlaceholder

Signature: distributePlaceholder(List<Map<String, Object>> distributionList)
Description: Distributes the placeholder document to specified recipients by delegating to the internal DocumentContext's distributeFile method.
Returns: void

3

applyActivityLocks

Signature: applyActivityLocks(String objects) Description: Applies activity locks to the specified object. Internally calls DocumentContext.applyActivityLocks with the revision ID from the hashMap, the provided objects string, and a task type of 1.
Returns: void

4

assignVisibility

Signature: assignVisibility(DocumentVO documentVO, Map<String, List<String>> dataMap)
Description: Assigns visibility settings to the specified placeholder document by delegating to the internal DocumentContext.
Returns: void

5

getCustomAttributeValue

Signature: getCustomAttributeValue(DocumentVO documentVO, String attributeName) Description: Retrieves the value of a custom attribute for the specified placeholder document.
Returns: List<String> - A list of strings representing the custom attribute values.

6

getPlaceholderDetails

Signature: getPlaceholderDetails(HashMap<Object, Object> optionMap)
Description: Retrieves placeholder details based on the provided options by delegating to DocumentContext.getDocumentDetails. Returns: DocumentVO - A DocumentVO object containing the document details.

7

getCustomAttributes

Signature: getCustomAttributes() Description: Retrieves all custom attributes for the placeholder document.
Returns: List<CustomAttributeVO> - A list of CustomAttributeVO objects.

8

getCustomAttributes

Signature: getCustomAttributes(HashMap<Object, Object> optionMap)
Description: Retrieves custom attributes based on the provided options.
Returns: List<CustomAttributeVO> - A list of CustomAttributeVO objects.

9

callExternalAPI

Signature: callExternalAPI(Map<Object, Object> distributeFileMap)
Description: Calls an external API with the provided file distribution details by delegating to the internal DocumentContext.
Returns: Map<String, String> - A map containing the response from the external API.

10

updatePlaceholders

Signature: updatePlaceholders(ArrayList<DocumentVO> listOfDocumentVO, HashMap<Object, Object> optionMap)
Description: Updates the list of placeholder DocumentVO objects with the specified options by delegating to DocumentContext.updateDocuments. Returns: boolean - true if the update was successful, false otherwise.

11

getFolderPath

Signature: getFolderPath(DocumentVO documentVO)
Description: Retrieves the folder path for the specified placeholder document.
Returns: String - The folder path as a string.

12

getCurrentUserDetails

Signature: getCurrentUserDetails() Description: Retrieves the current user details by delegating to the internal DocumentContext. Returns: UserVO - A UserVO object containing the current user details.

13

isAttributeValueExist

Signature: isAttributeValueExist(DocumentVO documentVO, Set<String> attributeNames, RevisionDetailsOption option, HashMap<Object, Object> optionMap) Description: Checks if the specified attributes exist for the given placeholder document. If the option is FOLDER_LEVEL_UNIQUE, it is automatically converted to FOLDER_LEVEL_INCLUDE_PLACEHOLDER before delegating to DocumentContext. Returns: Set<String> - A set of attribute names that exist.


Did this answer your question?