Package com.veeva.vault.sdk.api.annotation

Interface AnnotationService

All Superinterfaces:

Service

public interface AnnotationService
extends Service

Provides methods to manage document annotations in Vault.

Method Summary

Modifier and Type	Method	Description
BatchOperation<PositionalResult,AnnotationBatchDeleteError>	batchDeleteAnnotations(AnnotationBatchDeleteRequest request)	Given a List of unique annotation IDs, delete their associated annotations if they are found.
BatchOperation<AnnotationBatchSaveSuccess,AnnotationBatchSaveError>	batchSaveAnnotations(AnnotationBatchSaveRequest request)	Given a request that includes a List of Annotation objects, save the annotations to Vault.
Annotation.Builder	newAnnotationBuilder()	Creates a new Annotation.Builder.
Annotation.Builder	newAnnotationBuilderWithId(String id)	Creates a new Annotation.Builder for the specified unique annotation ID.
AnnotationBatchDeleteRequest.Builder	newBatchDeleteRequestBuilder()	Creates a new AnnotationBatchDeleteRequest.Builder.
AnnotationBatchSaveRequest.Builder	newBatchSaveRequestBuilder()	Creates a new AnnotationBatchSaveRequest.Builder.
AnnotationPlacemark.Builder	newPlacemarkBuilder()	Creates a new AnnotationPlacemark.Builder.
AnnotationReadRequest.Builder	newReadAnnotationRequestBuilder()	Creates a new AnnotationReadRequest.Builder.
AnnotationReplyReadRequest.Builder	newReadReplyRequestBuilder()	Creates a new AnnotationReplyReadRequest.Builder.
AnnotationReference.Builder	newReferenceBuilder()	Creates a new AnnotationReference.Builder.
AnnotationReadOperation	readAnnotations(AnnotationReadRequest readAnnotationRequest)	Given either a List of unique annotation IDs or a document version to read annotations from, returns an AnnotationReadOperation to execute.
AnnotationReadOperation	readReplies(AnnotationReplyReadRequest readReplyRequest)	Given the ID of a parent annotation, returns an AnnotationReadOperation to execute to read its replies.

Method Details

batchSaveAnnotations

BatchOperation<AnnotationBatchSaveSuccess,AnnotationBatchSaveError> batchSaveAnnotations(AnnotationBatchSaveRequest request)

Given a request that includes a List of Annotation objects, save the annotations to Vault. Annotations with IDs built using newAnnotationBuilderWithId(String) will be treated as updates, while Annotations without IDs built using newAnnotationBuilder() will be created. Updates may specify fields, placemarks, or references to update, or replies to append. New annotations must contain a placemark and the minimum required fields for their type.

Runs as a batch operation, for example:

annotationService.batchSaveAnnotations(annotations).onSuccesses(...).onErrors(...).ignoreErrors().execute();

Successes are gathered into AnnotationBatchSaveSuccess objects, which map the passed Annotations to the IDs of annotations that were successfully created based on their document and placemark data.

Errors are gathered into AnnotationBatchSaveError objects, which map the passed Annotations to error types defined by the AnnotationBatchSaveErrorType enum.

The maximum allowed batch size is 500 input Annotations.

Parameters:

request - a request including the Annotations to be created or updated, which must have a minimum amount of data based on their type

Returns:

the batch operation, which will save the annotations upon execution

readAnnotations

AnnotationReadOperation readAnnotations(AnnotationReadRequest readAnnotationRequest)

Given either a List of unique annotation IDs or a document version to read annotations from, returns an AnnotationReadOperation to execute.

Successes may be streamed, with each result being a fully populated Annotation object. If a particular annotation requested by ID is not found, it will not be included in the stream.

Errors are AnnotationReadErrorResult objects, which include error types defined by the AnnotationReadErrorType enum.

Replies will not be fetched unless specified by ID. Replies, if any, can be fetched with readReplies(AnnotationReplyReadRequest).

Parameters:

readAnnotationRequest - the request to read annotations

Returns:

an operation to read the requested annotations

readReplies

AnnotationReadOperation readReplies(AnnotationReplyReadRequest readReplyRequest)

Given the ID of a parent annotation, returns an AnnotationReadOperation to execute to read its replies.

Successes may be streamed, with each result being a fully populated Annotation object representing a reply. They will be in the order in which they appear on the parent.

Errors are AnnotationReadErrorResult objects, which include error types defined by the AnnotationReadErrorType enum.

Parameters:

readReplyRequest - the request to read the replies of a parent annotation

Returns:

an operation to read the requested replies

batchDeleteAnnotations

BatchOperation<PositionalResult,AnnotationBatchDeleteError> batchDeleteAnnotations(AnnotationBatchDeleteRequest request)

Given a List of unique annotation IDs, delete their associated annotations if they are found.

Runs as a batch operation, for example:

annotationService.batchDeleteAnnotations(annotationIds).onSuccesses(...).onErrors(...).ignoreErrors().execute();

Successes are gathered into PositionalResult objects, which indicate which inputs were successfully deleted, by input position.

Errors are gathered into AnnotationBatchDeleteError objects, which map the inputs that were not deleted to error types defined by the AnnotationBatchDeleteErrorType enum.

The maximum allowed batch size is 500 input IDs.

Parameters:

request - a request including the unique IDs of the annotations to be deleted

Returns:

the batch operation, which will save the annotations upon execution

newAnnotationBuilder

Annotation.Builder newAnnotationBuilder()

Creates a new Annotation.Builder.

Returns:

the created Annotation.Builder

newAnnotationBuilderWithId

Annotation.Builder newAnnotationBuilderWithId(String id)

Creates a new Annotation.Builder for the specified unique annotation ID. Annotation objects built with the resulting builder, and then passed to the batchSaveAnnotations(AnnotationBatchSaveRequest) method, will be counted as an update to the annotation with the specified ID.

Non-system managed fields may generally be updated unless there are additional restrictions due to annotation type or placemark type. Placemarks and references may also be updated. Any field, placemark, or reference list included using this builder will be counted as an update to the field, placemark, or reference list for that annotation. Replies may be appended to annotation types that support them, but cannot be removed.

Parameters:

id - the unique ID of the annotation to update

Returns:

the created Annotation.Builder

newBatchDeleteRequestBuilder

AnnotationBatchDeleteRequest.Builder newBatchDeleteRequestBuilder()

Creates a new AnnotationBatchDeleteRequest.Builder.

Returns:

the created AnnotationBatchDeleteRequest.Builder

newBatchSaveRequestBuilder

AnnotationBatchSaveRequest.Builder newBatchSaveRequestBuilder()

Creates a new AnnotationBatchSaveRequest.Builder.

Returns:

the created AnnotationBatchSaveRequest.Builder

newPlacemarkBuilder

AnnotationPlacemark.Builder newPlacemarkBuilder()

Creates a new AnnotationPlacemark.Builder.

Returns:

the created AnnotationPlacemark.Builder

newReadAnnotationRequestBuilder

AnnotationReadRequest.Builder newReadAnnotationRequestBuilder()

Creates a new AnnotationReadRequest.Builder.

Returns:

the created AnnotationReadRequest.Builder

newReadReplyRequestBuilder

AnnotationReplyReadRequest.Builder newReadReplyRequestBuilder()

Creates a new AnnotationReplyReadRequest.Builder.

Returns:

the created AnnotationReplyReadRequest.Builder

newReferenceBuilder

AnnotationReference.Builder newReferenceBuilder()

Creates a new AnnotationReference.Builder.

Returns:

the created AnnotationReference.Builder