Uses of Package
com.veeva.vault.sdk.api.annotation
Packages that use com.veeva.vault.sdk.api.annotation
Package
Description
This package provides interfaces to manage document annotations in Vault.
-
Classes in com.veeva.vault.sdk.api.annotation used by com.veeva.vault.sdk.api.annotationClassDescriptionRepresents a document annotation.Creates an instance of
Annotation.Represents a positional error result for batch delete operations calls fromAnnotationService, indicating that one of the inputs in the batch failed.Provides data about an error included in the response of batch delete operations provided byAnnotationService, including the error message and type.Represents the error types included in the response of batch delete operations provided byAnnotationServicewhen a particular input fails with an error.Represents a request to delete multiple annotations by providing aListof annotation IDs.Creates an instance ofAnnotationBatchDeleteRequest.Represents a positional error result for batch save operations calls fromAnnotationService, indicating that one of the inputs in the batch failed.Provides data about an error included in the response of batch save operations provided byAnnotationService, including the error message and type.Represents error types included in the response of batch save operations provided byAnnotationServicewhen a particular input fails with an error.Represents a request to create or update multiple annotations by providing aListofAnnotations.Creates an instance ofAnnotationBatchSaveRequest.Represents the result of processing anAnnotationService.batchSaveAnnotations(AnnotationBatchSaveRequest), indicating that one of theAnnotations passed in the batch successfully created at least one resulting annotation.Provides methods to retrieve common metadata information of the specified annotation field.Provides methods to retrieve the metadata of anAnnotationField.Creates an instance ofAnnotationFieldRequest.Represents an annotation placemark and provides methods to retrieve field values and type names for any annotation placemark type.Creates an instance ofAnnotationPlacemark.Provides methods to retrieve common metadata information of the specified annotation placemark field.Retrieves an instance ofAnnotationPlacemarkFieldto build the request for retrieving annotation placemark field metadata.Creates an instance ofAnnotationPlacemarkFieldRequest.Provides methods to retrieve common metadata information of the specified annotation placemark type.Retrieves an instance ofAnnotationPlacemarkTypeto build the request for retrieving annotation placemark type metadata.Creates an instance ofAnnotationPlacemarkTypeRequest.Used to request the value set of anAnnotationPlacemarkFieldon a particularAnnotationPlacemarkType.Creates an instance ofAnnotationPlacemarkValueSetRequest.Types of data supported byAnnotationPlacemarks.Represents an error included in the response of read operations provided byAnnotationService.Error types that may occur during read operations provided byAnnotationServicewhen a request fails with an error.A sequence of instructions that can be chained together to read annotations, building up to a final operation that can be executed withAnnotationReadOperation.execute().Requests to read multiple annotations by providing either aListof unique annotation IDs or a document version ID to read annotations from.A builder for anAnnotationReadRequest, including filters on the request.Response from a call toAnnotationService.readAnnotations(AnnotationReadRequest).Represents an annotation reference.Creates an instance ofAnnotationReference.Provides methods to retrieve common metadata information of the specified annotation reference field.Used to request the metadata of anAnnotationReferenceField.Creates an instance ofAnnotationReferenceFieldRequest.Provides methods to retrieve common metadata information of the specified annotation reference type.Used to request the metadata of anAnnotationReferenceType.Creates an instance ofAnnotationReferenceTypeRequest.Used to request the value set of anAnnotationReferenceFieldon a particularAnnotationReferenceType.Creates an instance ofAnnotationReferenceValueSetRequest.Types of data supported byAnnotationReferences.Requests to read the replies of a given parent annotation.Creates an instance ofAnnotationReplyReadRequest.Provides methods to retrieve common metadata information of the specified annotation type.Used to request the metadata of anAnnotationType.Creates an instance ofAnnotationTypeRequest.Used to request the value set of anAnnotationFieldon a particularAnnotationType.Creates an instance ofAnnotationValueSetRequest.Types of data supported byAnnotations.