Package com.veeva.vault.sdk.api.role

Interface DocumentRoleService

All Superinterfaces:

Service

public interface DocumentRoleService
extends Service

Provides methods to read and update DocumentRoles.

Method Summary

Modifier and Type	Method	Description
BatchOperation<Void,BatchOperationError>	batchAssignMissingUsers(List<DocumentVersion> documentVersions, String roleName, List<String> userIds)	Creates an operation which can be used to update document roles such that all of the given user IDs are on the given document lifecycle role on all of the given documents.
BatchOperation<Void,BatchOperationError>	batchUpdateDocumentRoles(List<DocumentRoleUpdate> documentRoleUpdates)	Creates an operation which can be used to update document roles.
GetDocumentRolesResponse	getDocumentRoles(List<DocumentVersion> documentVersions, String roleName)	Retrieves a GetDocumentRolesResponse object, which can be used to retrieve any manually assigned DocumentRoles for a given document.
GetGroupInDocumentRolesResponse	getGroupInDocumentRoles(Group group, List<DocumentRole> documentRoles)	For the given group, returns a GetGroupInDocumentRolesResponse which can be used to check if the group is in a particular document role.
GetMissingAssignmentsDocumentResponse	getMissingAssignments(List<DocumentVersion> documentVersions, String roleName, List<String> userIds)	Retrieves a GetMissingAssignmentsDocumentResponse which can be used to check for an incompleteness of document roles.
GetUserInDocumentRolesResponse	getUserInDocumentRoles(String userId, List<DocumentRole> documentRoles)	For a given userId, retrieves a GetUserInDocumentRolesResponse which can be used to check if the user is in a particular document role.
DocumentRoleUpdate	newDocumentRoleUpdate(String roleName, DocumentVersion documentVersion)	Creates a DocumentRoleUpdate which can be submitted to batchUpdateDocumentRoles(List) to update document roles on a particular document.

Method Details

getDocumentRoles

GetDocumentRolesResponse getDocumentRoles(List<DocumentVersion> documentVersions,
 String roleName)

Retrieves a GetDocumentRolesResponse object, which can be used to retrieve any manually assigned DocumentRoles for a given document.

The given roleName must be a valid option on each included DocumentVersion.

Parameters:

documentVersions - List of DocumentVersions to retrieve roles from. Cannot exceed 500 DocumentVersions.

roleName - name of a document lifecycle role, for example, approver__c

Returns:

a GetDocumentRolesResponse object, which can be used to retrieve roles from the List of DocumentVersions

getUserInDocumentRoles

GetUserInDocumentRolesResponse getUserInDocumentRoles(String userId,
 List<DocumentRole> documentRoles)

For a given userId, retrieves a GetUserInDocumentRolesResponse which can be used to check if the user is in a particular document role.

While a GetDocumentRolesResponse only contains manual assignments, this method will allow you to check if a user is in a document role from manual or automated assignments (such as Dynamic Access Control). In addition, this method will check if the user is in a document role indirectly, such as through a group.

Parameters:

userId - the ID for a user. Cannot be null.

documentRoles - List of DocumentRoles. Cannot be null or exceed 500 DocumentRoles.

Returns:

a GetUserInDocumentRolesResponse object, which can be used to retrieve users in the given DocumentRoles

getGroupInDocumentRoles

GetGroupInDocumentRolesResponse getGroupInDocumentRoles(Group group,
 List<DocumentRole> documentRoles)

For the given group, returns a GetGroupInDocumentRolesResponse which can be used to check if the group is in a particular document role.

While a GetDocumentRolesResponse only contains direct manual assignments, this method will allow you to check if a group is in a document role from manual or automated assignments.

Parameters:

group - a Group object. Cannot be null.

documentRoles - List of document roles to check. Cannot be null or exceed 500 DocumentRoles.

Returns:

the GetGroupInDocumentRolesResponse object, which can be used to check if the group is in the DocumentRole

newDocumentRoleUpdate

DocumentRoleUpdate newDocumentRoleUpdate(String roleName,
 DocumentVersion documentVersion)

Creates a DocumentRoleUpdate which can be submitted to batchUpdateDocumentRoles(List) to update document roles on a particular document.

Parameters:

roleName - name of a document lifecycle role, for example, approver__v

documentVersion - a document to update roles on

Returns:

a DocumentRoleUpdate instance which can be submitted to batchUpdateDocumentRoles(List) to update document roles on a document

batchUpdateDocumentRoles

BatchOperation<Void,BatchOperationError> batchUpdateDocumentRoles(List<DocumentRoleUpdate> documentRoleUpdates)

Creates an operation which can be used to update document roles.

The way that errors are handled can be specified on the returned BatchOperation. Once error-handling has been specified, the method BatchOperation.execute() must be called to finally execute the update. For example:

documentRoleService.batchUpdateDocumentRoles(documentRoleUpdates).rollbackOnErrors().execute()

Parameters:

documentRoleUpdates - a List of DocumentRoleUpdates to update. Cannot be null or exceed 500 DocumentRoleUpdates.

Returns:

an operation which can be used to update document roles

getMissingAssignments

GetMissingAssignmentsDocumentResponse getMissingAssignments(List<DocumentVersion> documentVersions,
 String roleName,
 List<String> userIds)

Retrieves a GetMissingAssignmentsDocumentResponse which can be used to check for an incompleteness of document roles.

The given roleName must be a valid option on each included DocumentVersion.

Parameters:

documentVersions - a List of DocumentVersions to check. Cannot be null or exceed 500 documents.

roleName - name of a document lifecycle role, for example, approver__c

userIds - a List of user IDs. Cannot be null or exceed 500 IDs.

Returns:

GetMissingAssignmentsDocumentResponse object which can be used to check for incompleteness of document roles

batchAssignMissingUsers

BatchOperation<Void,BatchOperationError> batchAssignMissingUsers(List<DocumentVersion> documentVersions,
 String roleName,
 List<String> userIds)

Creates an operation which can be used to update document roles such that all of the given user IDs are on the given document lifecycle role on all of the given documents.

The given roleName must be a valid option on each included DocumentVersion.

The way that errors are handled can be specified on the returned BatchOperation. Once error-handling has been specified, the method BatchOperation.execute() must be called to finally execute the update. For example:

documentRoleService.batchUpdateDocumentRoles(documentRoleUpdates).rollbackOnErrors().execute()

Parameters:

documentVersions - a List of document versions. Cannot be null or exceed 500 DocumentVersions.

roleName - name of a document lifecycle role, for example, approver__v

userIds - a List of user IDs. Cannot be null or exceed 500 IDs.

Returns:

an operation which can be used to update document roles