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

Interface DocumentRoleUpdate

public interface DocumentRoleUpdate
Provides methods to add or remove users and groups in a DocumentRole. These methods can only add or remove manually assigned users, not users added with Dynamic Access Control. DocumentRoleService.newDocumentRoleUpdate(String, DocumentVersion) returns this object. You can then use DocumentRoleService.batchUpdateDocumentRoles(List) to execute the update.

  • Method Details

    • addUsers

      void addUsers(List<String> userIds)
      Adds users to a role. Users added by this method are added to existing manually assigned users in a DocumentRole.
      Parameters:
      userIds - List of IDs of the users to add to the role. Users who already exist in the role are ignored. Invalid userIds result in batch operation errors under RecordRoleService.batchUpdateRecordRoles(List). Cannot be null or contain null elements.

    • removeUsers

      void removeUsers(List<String> userIds)
      Removes a user from a role. Users removed by this method are removed from existing manually assigned users in a DocumentRole.
      Parameters:
      userIds - ID of the user to add to the role. Users who do not exist in the role are ignored. Invalid userIds result in batch operation errors under RecordRoleService.batchUpdateRecordRoles(List). Cannot be null or contain null elements.

    • addGroups

      void addGroups(List<Group> groups)
      Adds groups to a role. Groups added by this method are added to existing manually assigned groups in a DocumentRole.
      Parameters:
      groups - List of groups to add to the role. Groups who already exist in the role are ignored. Invalid groups result in batch operation errors under RecordRoleService.batchUpdateRecordRoles(List). Cannot be null or contain null elements.

    • removeGroups

      void removeGroups(List<Group> groups)
      Removes groups from a role. Groups removed by this method are removed from existing manually assigned groups in a DocumentRole.
      Parameters:
      groups - List of groups to remove from the role. Groups that do not exist in the role are ignored. Invalid groups result in batch operation errors under RecordRoleService.batchUpdateRecordRoles(List). Cannot be null or contain null elements.