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

Interface GetDocumentRolesResponse

public interface GetDocumentRolesResponse

Provides methods to retrieve DocumentRole, returned from DocumentRoleService.getDocumentRoles(List, String).

Method Summary

Modifier and Type	Method	Description
DocumentRole	getDocumentRole(DocumentVersion documentVersion)	Retrieves a DocumentRole for a given document.

Method Details

getDocumentRole

DocumentRole getDocumentRole(DocumentVersion documentVersion)

Retrieves a DocumentRole for a given document. Only contains users assigned through manual assignment.

The resulting DocumentRole will be applied to the document lifecycle role included in the original call to DocumentRoleService.getDocumentRoles(List, String).

Parameters:

documentVersion - the document to retrieve role information from. Cannot be null.

Returns:

a DocumentRole object, or null if the given DocumentVersion was not included in the original call to DocumentRoleService.getDocumentRoles(List, String)