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

Interface AnnotationReadRequest.Builder

Enclosing interface:

AnnotationReadRequest

public static interface AnnotationReadRequest.Builder

A builder for an AnnotationReadRequest, including filters on the request.

Method Summary

Modifier and Type	Method	Description
AnnotationReadRequest	build()	Builds the AnnotationReadRequest based on the provided data.
AnnotationReadRequest.Builder	withAnnotationIds(List<String> annotationIds)	Conditional: The annotation IDs of the annotations to read.
AnnotationReadRequest.Builder	withAnnotationTypes(Set<String> annotationTypes)	Optional: Specifies the annotation types to limit the read operation to by name.
AnnotationReadRequest.Builder	withDocumentVersionId(String documentVersionId)	Conditional: The document version ID to request annotations from.

Method Details

withAnnotationIds

AnnotationReadRequest.Builder withAnnotationIds(List<String> annotationIds)

Conditional: The annotation IDs of the annotations to read. Required if a document version is not specified. If omitted, you must specify document version.

Parameters:

annotationIds - the annotation IDs

Returns:

this AnnotationReadRequest.Builder

withAnnotationTypes

AnnotationReadRequest.Builder withAnnotationTypes(Set<String> annotationTypes)

Optional: Specifies the annotation types to limit the read operation to by name. If not specified, all annotation types will be read.

Parameters:

annotationTypes - the annotation type names

Returns:

this AnnotationReadRequest.Builder

withDocumentVersionId

AnnotationReadRequest.Builder withDocumentVersionId(String documentVersionId)

Conditional: The document version ID to request annotations from. Format documentId_majorVersion_minorVersion, for example, 123_1_0. Required if annotation IDs are not specified. If omitted, you must specify annotation IDs.

Parameters:

documentVersionId - the document version ID

Returns:

this AnnotationReadRequest.Builder

build

AnnotationReadRequest build()

Builds the AnnotationReadRequest based on the provided data.

Returns:

the completed AnnotationReadRequest