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

Interface GetUserInDocumentRolesResponse

public interface GetUserInDocumentRolesResponse
Provides methods to check if a particular user is assigned to a given document role. Returned from DocumentRoleService.getUserInDocumentRoles(String, List).

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isUserInDocumentRole(DocumentRole documentRole)
    Checks if a particular user is assigned to the given document role.

  • Method Details

    • isUserInDocumentRole

      boolean isUserInDocumentRole(DocumentRole documentRole)
      Checks if a particular user is assigned to the given document role.

      The user checked here is the same user provided in the call to DocumentRoleService.getUserInDocumentRoles(String, List).

      Unlike GetDocumentRolesResponse, this method checks against all sources of roles including automated assignments such as Dynamic Access Control. In addition, this method will check if the user has indirect access to the role, such as through a group.

      Parameters:
      documentRole - the document role to check against. Cannot be null.
      Returns:
      true if the user is assigned to the given document role, otherwise false. Also returns false if the given DocumentRole was not included in the original call to DocumentRoleService.getUserInDocumentRoles(String, List).