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

Interface GetMissingAssignmentsDocumentResponse

public interface GetMissingAssignmentsDocumentResponse
Provides methods to check which users or documents are missing assignments in a particular role. Returned from DocumentRoleService.getMissingAssignments(List, String, List).

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getDocumentIds()
    Retrieves the IDs of documents which are missing one or more users provided to the original service call.
    List<DocumentVersion>
    getDocumentVersions()
    Retrieves the documents which are missing one or more users provided to the original service call.
    List<String>
    getUsers()
    Retrieves the IDs of users which are missing in one or more documents provided to the original service call.

  • Method Details

    • getUsers

      List<String> getUsers()
      Retrieves the IDs of users which are missing in one or more documents provided to the original service call.

      The users included in this list are guaranteed to be missing in at least one document in the getDocumentIds() and getDocumentVersions() methods, however are not guaranteed to be missing in all of the documents from those methods.

      Returns:
      a List of user IDs which are missing in one or more documents provided to the original service call. Never returns null.

    • getDocumentIds

      List<String> getDocumentIds()
      Retrieves the IDs of documents which are missing one or more users provided to the original service call.

      The documents included in this list are guaranteed to be missing at least one user from the getUsers() method, however they are not guaranteed to be missing all of the users from that method.

      Returns:
      a List of document IDs which are missing at least one or more users provided to the original service call. Never returns null.

    • getDocumentVersions

      List<DocumentVersion> getDocumentVersions()
      Retrieves the documents which are missing one or more users provided to the original service call.

      The documents included in this list are guaranteed to be missing at least one user from the getUsers() method, however they are not guaranteed to be missing all of the users from that method.

      Returns:
      a List of documents which are missing at least one or more users provided to the original service call. Never returns null.