Package com.veeva.vault.sdk.api.document

Interface DocumentService

All Superinterfaces:

Service

public interface DocumentService
extends Service

Provides methods to update and delete documents. You can only update the latest version of a document.

Method Summary

Modifier and Type	Method	Description
DocumentBatchCreateOperation	batchCreateDocuments(DocumentBatchCreateRequest request)	Creates an operation to create documents specified in the DocumentBatchCreateRequest.
DocumentVersionBatchCreateOperation	batchCreateDocumentVersions(DocumentVersionBatchCreateRequest request)	Creates an operation to create document versions specified in the DocumentVersionBatchCreateRequest.
DocumentBatchDeleteOperation	batchDeleteDocuments(DocumentBatchDeleteRequest request)	Creates an operation to delete documents and document versions specified in the DocumentBatchDeleteRequest.
DocumentBatchReclassifyOperation	batchReclassifyDocuments(DocumentBatchReclassifyRequest request)	Creates an operation to reclassify documents specified in the DocumentBatchReclassifyRequest.
DocumentVersionBatchUpdateOperation	batchUpdateDocumentVersions(DocumentVersionBatchUpdateRequest request)	Creates an operation to update document versions specified in the DocumentVersionBatchUpdateRequest.
SaveDocumentVersionsResponse	createAttachments(List<? extends SharedAttachment> sharedAttachments)	Creates new attachment- or attachment-versions for a document or an object record.
SaveDocumentVersionsResponse	createDocuments(List<DocumentVersion> documentVersions)	Deprecated. as of 26R1.1, replaced by batchCreateDocuments(DocumentBatchCreateRequest)
SaveDocumentVersionsResponse	createRenditions(List<DocumentRendition> documentRenditions)	Creates new renditions for a document.
DeleteDocumentVersionsResponse	deleteDocumentVersions(List<DocumentVersion> documentVersions)	Deprecated. as of 26R1.1, replaced by batchDeleteDocuments(DocumentBatchDeleteRequest)
SaveDocumentVersionsResponse	migrateDocumentVersions(List<DocumentVersion> documentVersions)	Creates new document-versions for existing documents.
DocumentVersion	newDocument()	Instantiates a new, empty DocumentVersion.
DocumentAttachment	newDocumentAttachment(FileReference fileReference, String docId)	Instantiates a DocumentAttachment and sets docId and fileReference.
DocumentAttachmentFileReference	newDocumentAttachmentFileReference(ConnectionContext connectionContext, String attachmentId)	Instantiates a DocumentAttachmentFileReference and sets the ID.
DocumentBatchCreateRequest.Builder	newDocumentBatchCreateRequestBuilder()	Creates a DocumentBatchCreateRequest.Builder
DocumentBatchDeleteRequest.Builder	newDocumentBatchDeleteRequestBuilder()	Creates a DocumentBatchDeleteRequest.Builder
DocumentBatchReclassifyRequest.Builder	newDocumentBatchReclassifyRequestBuilder()	Creates a DocumentBatchReclassifyRequest.Builder.
DocumentRendition	newDocumentRendition(FileReference fileReference, String docVersion, String renditionTypeName)	Instantiates a DocumentRendition and sets docId and fileReference.
DocumentRenditionFileReference	newDocumentRenditionFileReference(ConnectionContext connectionContext, String documentVersionId, String renditionTypeName)	Instantiates a DocumentRenditionFileReference and sets the rendition type, ID, major and minor version.
DocumentSourceFileReference	newDocumentSourceFileReference(ConnectionContext connectionContext, String documentVersionId)	Instantiates a DocumentSourceFileReference and sets the ID, major and minor version.
DocumentVersion	newDocumentVersion(String documentVersionId)	Deprecated. as of 19R3.5, replaced by newVersionWithId(String)
DocumentVersionBatchCreateRequest.Builder	newDocumentVersionBatchCreateRequestBuilder()	Creates a DocumentVersionBatchCreateRequest.Builder
DocumentVersionBatchUpdateRequest.Builder	newDocumentVersionBatchUpdateRequestBuilder()	Creates a DocumentVersionBatchUpdateRequest.Builder
DocumentVersion	newDocumentWithId(String docId)	Instantiates a DocumentVersion with the given id and sets the version to the latest version of the document.
DocumentVersion	newVersion(String docId)	Instantiates a DocumentVersion and sets the document ID.
DocumentVersion	newVersionWithId(String documentVersionId)	Instantiates a DocumentVersion and sets the ID, major version, and minor version.
SaveDocumentVersionsResponse	saveDocumentVersions(List<DocumentVersion> documentVersions)	Deprecated. as of 26R1.1, replaced by batchUpdateDocumentVersions(DocumentVersionBatchUpdateRequest)

Method Details

newDocumentVersion

@Deprecated
DocumentVersion newDocumentVersion(String documentVersionId)

Deprecated.

as of 19R3.5, replaced by newVersionWithId(String)

Instantiates a DocumentVersion and sets the ID, major version, and minor version. Use this method to create an instance of an existing version of a document for updating or deleting. While you can delete any document version, you can only update the latest version of a document. If you want to update a document, we recommend newDocumentWithId(String).

Parameters:

documentVersionId - the document ID, major version, and minor version, in the format id_major_minor. For example, 951_0_1.

Returns:

a data-holder for an existing version of a document

newDocumentWithId

DocumentVersion newDocumentWithId(String docId)

Instantiates a DocumentVersion with the given id and sets the version to the latest version of the document.

Use this method to create an instance of the latest version of an existing document. You can then update or delete this document version.

Parameters:

docId - the document ID

Returns:

a data-holder for the latest version of an existing document

saveDocumentVersions

@Deprecated
SaveDocumentVersionsResponse saveDocumentVersions(List<DocumentVersion> documentVersions)

Deprecated.

as of 26R1.1, replaced by batchUpdateDocumentVersions(DocumentVersionBatchUpdateRequest)

Save the specified DocumentVersion instances. After updating the latest version of a document, use this method to save the document.

This saves the DocumentVersion instances regardless of the current user's access to that DocumentVersion.

The total number of DocumentVersion instances in the input list cannot exceed 500.

This is an all-or-nothing operation. If one or more documents fail to save, users see an error message and the operation is rolled back.

Parameters:

documentVersions - List of DocumentVersion instances to save

Returns:

the response of the save process

deleteDocumentVersions

@Deprecated
DeleteDocumentVersionsResponse deleteDocumentVersions(List<DocumentVersion> documentVersions)

Deprecated.

as of 26R1.1, replaced by batchDeleteDocuments(DocumentBatchDeleteRequest)

Delete the specified List of DocumentVersion instances.

A delete can be either a single version delete or document delete. If an input DocumentVersion has no major version and no minor version, that's an indication this is a complete document delete. If the input DocumentVersion has a major and minor version, that's an indication this is a document version delete.

This is an all-or-nothing operation. If one or more documents fail to delete, users see an error message and the operation is rolled back.

Parameters:

documentVersions - List of DocumentVersion instances to delete

Returns:

the response of the delete process

newVersionWithId

DocumentVersion newVersionWithId(String documentVersionId)

Instantiates a DocumentVersion and sets the ID, major version, and minor version. Use this method to create an instance of an existing version of a document for updating or deleting. While you can delete any document version, you can only update the latest version of a document.

To update a document, we recommend using newDocumentWithId(String).

Parameters:

documentVersionId - the document ID, major version, and minor version, in the format id_major_minor. For example, 951_0_1.

Returns:

a data-holder for an existing version of a document

newDocument

DocumentVersion newDocument()

Instantiates a new, empty DocumentVersion. Use this method to create an instance of a new document and its first version.

Returns:

a data-holder for a new document

newVersion

DocumentVersion newVersion(String docId)

Instantiates a DocumentVersion and sets the document ID. Use this method to create a new version for an existing document. Existing documents can be identified by the docId.

Parameters:

docId - the ID of the existing document

Returns:

a data-holder for a new version of an existing document

newDocumentSourceFileReference

DocumentSourceFileReference newDocumentSourceFileReference(ConnectionContext connectionContext,
 String documentVersionId)

Instantiates a DocumentSourceFileReference and sets the ID, major and minor version.

Parameters:

connectionContext - contains contextual connection information

documentVersionId - the document ID, major version, and minor version, in the format id_major_minor. For example, 951_0_1.

Returns:

a data-holder for a source file DocumentSourceFileReference

newDocumentRenditionFileReference

DocumentRenditionFileReference newDocumentRenditionFileReference(ConnectionContext connectionContext,
 String documentVersionId,
 String renditionTypeName)

Instantiates a DocumentRenditionFileReference and sets the rendition type, ID, major and minor version.

Parameters:

connectionContext - contains contextual connection information

documentVersionId - the document ID, major version, and minor version, in the format id_major_minor For example, 951_0_1.

renditionTypeName - name of rendition type

Returns:

a data-holder for a rendition file DocumentRenditionFileReference

newDocumentAttachmentFileReference

DocumentAttachmentFileReference newDocumentAttachmentFileReference(ConnectionContext connectionContext,
 String attachmentId)

Instantiates a DocumentAttachmentFileReference and sets the ID.

Parameters:

connectionContext - contains contextual connection information

attachmentId - the attachment ID, for example, 952

Returns:

a data-holder for an attachment file DocumentAttachmentFileReference

newDocumentAttachment

DocumentAttachment newDocumentAttachment(FileReference fileReference,
 String docId)

Instantiates a DocumentAttachment and sets docId and fileReference.

Parameters:

fileReference - file reference pointing to the original file

docId - ID of the document which the attachment is associate with

Returns:

instantiated DocumentAttachment

newDocumentRendition

DocumentRendition newDocumentRendition(FileReference fileReference,
 String docVersion,
 String renditionTypeName)

Instantiates a DocumentRendition and sets docId and fileReference.

Parameters:

fileReference - file reference pointing to the original file

docVersion - version of the document which the rendition is associate with. For example, 1_0_1.

renditionTypeName - rendition type name of the new rendition

Returns:

instantiated DocumentRendition

createDocuments

@Deprecated
SaveDocumentVersionsResponse createDocuments(List<DocumentVersion> documentVersions)

Deprecated.

as of 26R1.1, replaced by batchCreateDocuments(DocumentBatchCreateRequest)

Creates new documents. After constructing the first version of the new documents, use this method to save the new documents and first version. This is an all-or-nothing operation. If one or more documents fail to save, users see an error message and the operation rolls back.

Parameters:

documentVersions - list of DocumentVersion instances to create

Returns:

the response of the save process

migrateDocumentVersions

SaveDocumentVersionsResponse migrateDocumentVersions(List<DocumentVersion> documentVersions)

Creates new document-versions for existing documents. After constructing the new versions of existing documents, use this method to create them. This is an all-or-nothing operation. If one or more documents fail to save, users see an error message and the operation rolls back.

Parameters:

documentVersions - list of DocumentVersion instances to create

Returns:

the response of the save process

createAttachments

SaveDocumentVersionsResponse createAttachments(List<? extends SharedAttachment> sharedAttachments)

Creates new attachment- or attachment-versions for a document or an object record. After constructing the new attachments, use this method to create them. This is an all-or-nothing operation. If one or more attachment versions fail to save, users see an error message and the operation rolls back.

Parameters:

sharedAttachments - list of SharedAttachment or its subclasses to create

Returns:

the response of the save process

createRenditions

SaveDocumentVersionsResponse createRenditions(List<DocumentRendition> documentRenditions)

Creates new renditions for a document. After constructing the new renditions, use this method to create them. This is an all-or-nothing operation. If one or more renditions fail to save, users see an error message and the operation rolls back.

Parameters:

documentRenditions - list of DocumentRendition to create

Returns:

the response of the save process

newDocumentBatchCreateRequestBuilder

DocumentBatchCreateRequest.Builder newDocumentBatchCreateRequestBuilder()

Creates a DocumentBatchCreateRequest.Builder

Returns:

the created DocumentBatchCreateRequest.Builder

batchCreateDocuments

DocumentBatchCreateOperation batchCreateDocuments(DocumentBatchCreateRequest request)

Creates an operation to create documents specified in the DocumentBatchCreateRequest.

You can specify how to handle errors and successes on the returned BatchOperation. You can then call BatchOperation.execute() to execute the creation. For example:

 
 documentService.batchCreateDocuments(documentBatchCreateRequest).rollbackOnErrors().execute()

All Documents in the list specified in DocumentBatchCreateRequest must not have an id and their total cannot exceed 500.

Parameters:

request - contains the list of DocumentVersion instances to create

Returns:

an operation to create the documents

newDocumentVersionBatchCreateRequestBuilder

DocumentVersionBatchCreateRequest.Builder newDocumentVersionBatchCreateRequestBuilder()

Creates a DocumentVersionBatchCreateRequest.Builder

Returns:

the created DocumentVersionBatchCreateRequest.Builder

batchCreateDocumentVersions

DocumentVersionBatchCreateOperation batchCreateDocumentVersions(DocumentVersionBatchCreateRequest request)

Creates an operation to create document versions specified in the DocumentVersionBatchCreateRequest. This also supports creating new draft versions.

You can specify how to handle errors and successes on the returned BatchOperation. You can then call BatchOperation.execute() to execute the creation. For example:

 
 documentService.batchCreateDocumentVersions(documentVersionBatchCreateRequest).rollbackOnErrors().execute()

All Documents in the list specified in DocumentBatchCreateRequest must have an id and their total cannot exceed 500.

Parameters:

request - contains the list of DocumentVersion instances to create

Returns:

an operation to create the document versions

newDocumentVersionBatchUpdateRequestBuilder

DocumentVersionBatchUpdateRequest.Builder newDocumentVersionBatchUpdateRequestBuilder()

Creates a DocumentVersionBatchUpdateRequest.Builder

Returns:

the created DocumentVersionBatchUpdateRequest.Builder

batchUpdateDocumentVersions

DocumentVersionBatchUpdateOperation batchUpdateDocumentVersions(DocumentVersionBatchUpdateRequest request)

Creates an operation to update document versions specified in the DocumentVersionBatchUpdateRequest.

An update can be either be on the document's latest version or the specified version. If an input DocumentVersion has no major version or no minor version, then the operation updates the latest version. If an input DocumentVersion has a major and minor version, then the operation updates that specified version.

You can specify how to handle errors and successes on the returned BatchOperation. You can then call BatchOperation.execute() to execute the update. For example:

 
 documentService.batchUpdateDocumentVersions(documentBatchCreateRequest).rollbackOnErrors().execute()

All DocumentVersions in the list specified in DocumentVersionBatchUpdateRequest must have an id and must not be a duplicate within the batch. The batch total cannot exceed 500.

Parameters:

request - contains the list of DocumentVersion instances to update

Returns:

an operation to update document versions

newDocumentBatchDeleteRequestBuilder

DocumentBatchDeleteRequest.Builder newDocumentBatchDeleteRequestBuilder()

Creates a DocumentBatchDeleteRequest.Builder

Returns:

the created DocumentBatchDeleteRequest.Builder

batchDeleteDocuments

DocumentBatchDeleteOperation batchDeleteDocuments(DocumentBatchDeleteRequest request)

Creates an operation to delete documents and document versions specified in the DocumentBatchDeleteRequest.

A delete operation can be either a single version delete or document delete. If an input DocumentVersion has no major version and no minor version value, the whole document is deleted. If the input DocumentVersion has major and minor version values, then the specified document version is deleted.

You can specify how to handle errors and successes on the returned BatchOperation. You can then call BatchOperation.execute() to execute the deletion. For example:

 
 documentService.batchDeleteDocuments(documentBatchDeleteRequest).rollbackOnErrors().execute()

All DocumentVersions in the list specified in DocumentBatchDeleteRequest must have an id and must not be a duplicate within the batch. The batch total cannot exceed 500.

Parameters:

request - contains the list of DocumentVersion instances to delete and additional parameters

Returns:

an operation to delete documents and document versions

newDocumentBatchReclassifyRequestBuilder

DocumentBatchReclassifyRequest.Builder newDocumentBatchReclassifyRequestBuilder()

Creates a DocumentBatchReclassifyRequest.Builder.

Returns:

the created DocumentBatchReclassifyRequest.Builder

batchReclassifyDocuments

DocumentBatchReclassifyOperation batchReclassifyDocuments(DocumentBatchReclassifyRequest request)

Creates an operation to reclassify documents specified in the DocumentBatchReclassifyRequest.

You can specify how to handle errors and successes on the returned BatchOperation. You can then call BatchOperation.execute() to execute the reclassification. For example:

 
 documentService.batchReclassifyDocuments(documentBatchReclassifyRequest).rollbackOnErrors().execute()

All DocumentVersions in the list specified in DocumentBatchReclassifyRequest must have an id and must not be a duplicate within the batch. The batch total cannot exceed 500.

Parameters:

request - contains the list of DocumentVersion instances to reclassify and additional parameters

Returns:

an operation to reclassify the documents