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

Interface AnnotationMetadataService

All Superinterfaces:

Service

public interface AnnotationMetadataService
extends Service

Provides methods to retrieve metadata about annotation types, annotation fields, placemark types, placemark fields, reference types, and reference fields.

Method Summary

Modifier and Type	Method	Description
AnnotationField	getField(AnnotationFieldRequest request)	Retrieves a single AnnotationField.
AnnotationPlacemarkField	getPlacemarkField(AnnotationPlacemarkFieldRequest request)	Retrieves a single AnnotationPlacemarkField.
AnnotationPlacemarkType	getPlacemarkType(AnnotationPlacemarkTypeRequest request)	Retrieves a single AnnotationPlacemarkType.
<T> Collection<T>	getPlacemarkValueSet(AnnotationPlacemarkValueSetRequest<T> request)	Retrieves the value set for a particular placemark field on a particular placemark type.
AnnotationReferenceField	getReferenceField(AnnotationReferenceFieldRequest request)	Retrieves a single AnnotationReferenceField.
AnnotationReferenceType	getReferenceType(AnnotationReferenceTypeRequest request)	Retrieves a single AnnotationReferenceType.
<T> Collection<T>	getReferenceValueSet(AnnotationReferenceValueSetRequest<T> request)	Retrieves the value set for a particular reference field on a particular reference type.
AnnotationType	getType(AnnotationTypeRequest request)	Retrieves a single AnnotationType.
<T> Collection<T>	getValueSet(AnnotationValueSetRequest<T> request)	Retrieves the value set for a particular field on a particular annotation type.
AnnotationFieldRequest.Builder	newFieldRequestBuilder()	Creates a new AnnotationFieldRequest.Builder.
AnnotationPlacemarkFieldRequest.Builder	newPlacemarkFieldRequestBuilder()	Creates a new AnnotationPlacemarkFieldRequest.Builder.
AnnotationPlacemarkTypeRequest.Builder	newPlacemarkTypeRequestBuilder()	Creates a new AnnotationPlacemarkTypeRequest.Builder.
<T> AnnotationPlacemarkValueSetRequest.Builder<T>	newPlacemarkValueSetRequestBuilder(AnnotationPlacemarkValueType<T> valueType)	Creates a new AnnotationPlacemarkValueSetRequest.Builder.
AnnotationReferenceFieldRequest.Builder	newReferenceFieldRequestBuilder()	Creates a new AnnotationReferenceFieldRequest.Builder.
AnnotationReferenceTypeRequest.Builder	newReferenceTypeRequestBuilder()	Creates a new AnnotationReferenceTypeRequest.Builder.
<T> AnnotationReferenceValueSetRequest.Builder<T>	newReferenceValueSetRequestBuilder(AnnotationReferenceValueType<T> valueType)	Creates a new AnnotationReferenceValueSetRequest.Builder.
AnnotationTypeRequest.Builder	newTypeRequestBuilder()	Creates a new AnnotationTypeRequest.Builder.
<T> AnnotationValueSetRequest.Builder<T>	newValueSetRequestBuilder(AnnotationValueType<T> valueType)	Creates a new AnnotationValueSetRequest.Builder.

Method Details

newFieldRequestBuilder

AnnotationFieldRequest.Builder newFieldRequestBuilder()

Creates a new AnnotationFieldRequest.Builder.

Returns:

the created AnnotationFieldRequest.Builder

getField

AnnotationField getField(AnnotationFieldRequest request)

Retrieves a single AnnotationField.

Parameters:

request - the AnnotationFieldRequest containing the information needed to retrieve the annotation field metadata. Cannot be null or empty.

Returns:

an AnnotationField containing the metadata of the requested annotation field

newTypeRequestBuilder

AnnotationTypeRequest.Builder newTypeRequestBuilder()

Creates a new AnnotationTypeRequest.Builder.

Returns:

the created AnnotationTypeRequest.Builder

getType

AnnotationType getType(AnnotationTypeRequest request)

Retrieves a single AnnotationType.

Parameters:

request - the AnnotationTypeRequest containing the information needed to retrieve the annotation type metadata. Cannot be null or empty.

Returns:

an AnnotationType containing the metadata of the requested annotation type

newPlacemarkFieldRequestBuilder

AnnotationPlacemarkFieldRequest.Builder newPlacemarkFieldRequestBuilder()

Creates a new AnnotationPlacemarkFieldRequest.Builder.

Returns:

the created AnnotationPlacemarkFieldRequest.Builder

getPlacemarkField

AnnotationPlacemarkField getPlacemarkField(AnnotationPlacemarkFieldRequest request)

Retrieves a single AnnotationPlacemarkField.

Parameters:

request - the AnnotationPlacemarkFieldRequest containing the information needed to retrieve the annotation placemark field metadata. Cannot be null or empty.

Returns:

an AnnotationPlacemarkField containing the metadata of the requested annotation placemark field

newPlacemarkTypeRequestBuilder

AnnotationPlacemarkTypeRequest.Builder newPlacemarkTypeRequestBuilder()

Creates a new AnnotationPlacemarkTypeRequest.Builder.

Returns:

the created AnnotationPlacemarkTypeRequest.Builder

getPlacemarkType

AnnotationPlacemarkType getPlacemarkType(AnnotationPlacemarkTypeRequest request)

Retrieves a single AnnotationPlacemarkType.

Parameters:

request - the AnnotationPlacemarkTypeRequest containing the information needed to retrieve the annotation placemark type metadata. Cannot be null or empty.

Returns:

an AnnotationPlacemarkType containing the metadata of the requested annotation placemark type

newReferenceFieldRequestBuilder

AnnotationReferenceFieldRequest.Builder newReferenceFieldRequestBuilder()

Creates a new AnnotationReferenceFieldRequest.Builder.

Returns:

the created AnnotationReferenceFieldRequest.Builder

getReferenceField

AnnotationReferenceField getReferenceField(AnnotationReferenceFieldRequest request)

Retrieves a single AnnotationReferenceField.

Parameters:

request - the AnnotationReferenceFieldRequest containing the information needed to retrieve the annotation reference field metadata. Cannot be null or empty.

Returns:

an AnnotationReferenceField containing the metadata of the requested annotation reference field

newReferenceTypeRequestBuilder

AnnotationReferenceTypeRequest.Builder newReferenceTypeRequestBuilder()

Creates a new AnnotationReferenceTypeRequest.Builder.

Returns:

the created AnnotationReferenceTypeRequest.Builder

getReferenceType

AnnotationReferenceType getReferenceType(AnnotationReferenceTypeRequest request)

Retrieves a single AnnotationReferenceType.

Parameters:

request - the AnnotationReferenceTypeRequest containing the information needed to retrieve the annotation reference type metadata. Cannot be null or empty.

Returns:

an AnnotationReferenceType containing the metadata of the requested annotation reference type

newValueSetRequestBuilder

<T> AnnotationValueSetRequest.Builder<T> newValueSetRequestBuilder(AnnotationValueType<T> valueType)

Creates a new AnnotationValueSetRequest.Builder.

Type Parameters:

T - the Java class that backs the value type

Parameters:

valueType - the value type of the field to request the value set for

Returns:

the created AnnotationValueSetRequest.Builder

getValueSet

<T> Collection<T> getValueSet(AnnotationValueSetRequest<T> request)

Retrieves the value set for a particular field on a particular annotation type. Relevant to fields that are allowed on the specified annotation type, and that return true for AnnotationField.hasValueSet().

Type Parameters:

T - the Java class that backs the value type

Parameters:

request - the AnnotationValueSetRequest containing the field and type information needed to retrieve the value set

Returns:

the value set for the specified field

newPlacemarkValueSetRequestBuilder

<T> AnnotationPlacemarkValueSetRequest.Builder<T> newPlacemarkValueSetRequestBuilder(AnnotationPlacemarkValueType<T> valueType)

Creates a new AnnotationPlacemarkValueSetRequest.Builder.

Type Parameters:

T - the Java class that backs the value type

Parameters:

valueType - the value type of the placemark field to request the value set for

Returns:

the created AnnotationPlacemarkValueSetRequest.Builder

getPlacemarkValueSet

<T> Collection<T> getPlacemarkValueSet(AnnotationPlacemarkValueSetRequest<T> request)

Retrieves the value set for a particular placemark field on a particular placemark type. Relevant to fields that are allowed on the specified placemark type, and that return true for AnnotationPlacemarkField.hasValueSet().

Type Parameters:

T - the Java class that backs the value type

Parameters:

request - the AnnotationPlacemarkValueSetRequest containing the field and type information needed to retrieve the value set

Returns:

the value set for the specified field

newReferenceValueSetRequestBuilder

<T> AnnotationReferenceValueSetRequest.Builder<T> newReferenceValueSetRequestBuilder(AnnotationReferenceValueType<T> valueType)

Creates a new AnnotationReferenceValueSetRequest.Builder.

Type Parameters:

T - the Java class that backs the value type

Parameters:

valueType - the value type of the reference field to request the value set for

Returns:

the created AnnotationReferenceValueSetRequest.Builder

getReferenceValueSet

<T> Collection<T> getReferenceValueSet(AnnotationReferenceValueSetRequest<T> request)

Retrieves the value set for a particular reference field on a particular reference type. Relevant to fields that are allowed on the specified reference type, and that return true for AnnotationReferenceField.hasValueSet().

Type Parameters:

T - the Java class that backs the value type

Parameters:

request - the AnnotationReferenceValueSetRequest containing the field and type information needed to retrieve the value set

Returns:

the value set for the specified field