Package | Description |
---|---|
com.veeva.vault.sdk.api.action |
This package provides interfaces to create custom actions.
|
com.veeva.vault.sdk.api.document |
This package provides interfaces to manage documents and binders.
|
com.veeva.vault.sdk.api.role |
This package provides interfaces to retrieve and manage role membership for a document or object record.
|
Modifier and Type | Method and Description |
---|---|
List<DocumentVersion> |
DocumentActionContext.getDocumentVersions()
Retrieves the document versions this action is executing against.
|
Modifier and Type | Method and Description |
---|---|
DocumentVersion |
DocumentService.newDocumentVersion(String docVer)
Instantiates a
DocumentVersion and sets the id, major version, and minor version. |
DocumentVersion |
DocumentService.newDocumentWithId(String docId)
Instantiates a
DocumentVersion with the given id and sets the version to the latest version
of the document. |
Modifier and Type | Method and Description |
---|---|
DeleteDocumentVersionsResponse |
DocumentService.deleteDocumentVersions(List<DocumentVersion> documentVersions)
Delete the specified List of DocumentVersions.
|
SaveDocumentVersionsResponse |
DocumentService.saveDocumentVersions(List<DocumentVersion> documentVersions)
Save the specified DocumentVersions.
|
Modifier and Type | Method and Description |
---|---|
DocumentVersion |
DocumentRole.getDocumentVersion()
Retrieves the document for which this document role applies to.
|
Modifier and Type | Method and Description |
---|---|
List<DocumentVersion> |
GetMissingAssignmentsDocumentResponse.getDocumentVersions()
Retrieves the documents which are missing one or more users provided to the original service call.
|
Modifier and Type | Method and Description |
---|---|
DocumentRole |
GetDocumentRolesResponse.getDocumentRole(DocumentVersion documentVersion)
Retrieves a
DocumentRole for a given document. |
DocumentRoleUpdate |
DocumentRoleService.newDocumentRoleUpdate(String roleName,
DocumentVersion documentVersion)
Creates a
DocumentRoleUpdate which can be submitted to DocumentRoleService.batchUpdateDocumentRoles(List) to update
document roles on a particular document. |
Modifier and Type | Method and Description |
---|---|
BatchOperation<Void,BatchOperationError> |
DocumentRoleService.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.
|
GetDocumentRolesResponse |
DocumentRoleService.getDocumentRoles(List<DocumentVersion> documentVersions,
String roleName)
Retrieves a
GetDocumentRolesResponse object, which can be used to retrieve any manually assigned
DocumentRole s for a given document. |
GetMissingAssignmentsDocumentResponse |
DocumentRoleService.getMissingAssignments(List<DocumentVersion> documentVersions,
String roleName,
List<String> userIds)
Retrieves a
GetMissingAssignmentsDocumentResponse which can be used to check for an incompleteness of
document roles. |
Copyright © Veeva Systems 2017–2019. All rights reserved.