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

Interface DocumentMetadataService

All Superinterfaces:

Service

public interface DocumentMetadataService
extends Service

Provides methods to retrieve document type and document field metadata.

Method Summary

Modifier and Type	Method	Description
DocumentFieldMetadataResponse	getDocumentFieldMetadata(DocumentFieldMetadataRequest request)	Retrieves multiple DocumentFieldMetadata.
DocumentType	getDocumentType(DocumentTypeRequest request)	Retrieves a single DocumentType.
DocumentField	getField(String fieldName)	Deprecated. as of 25R2.2, replaced by getDocumentFieldMetadata(DocumentFieldMetadataRequest)
DocumentFieldCollectionResponse	getFields(DocumentFieldCollectionRequest request)	Deprecated. as of 25R2.2, replaced by getDocumentFieldMetadata(DocumentFieldMetadataRequest)
DocumentFieldCollectionRequest.Builder	newDocumentFieldCollectionRequestBuilder()	Deprecated. as of 25R2.2, replaced by newDocumentFieldMetadataRequestBuilder()
DocumentFieldFilter.Builder	newDocumentFieldFilterBuilder()	Deprecated. as of 25R2.2, replaced by newDocumentFieldMetadataRequestBuilder()
DocumentFieldMetadataRequest.Builder	newDocumentFieldMetadataRequestBuilder()	Creates a DocumentFieldMetadataRequest.Builder.
DocumentTypeRequest.Builder	newDocumentTypeRequestBuilder()	Creates a DocumentTypeRequest.Builder.

Method Details

getField

@Deprecated
DocumentField getField(String fieldName)

Deprecated.

as of 25R2.2, replaced by getDocumentFieldMetadata(DocumentFieldMetadataRequest)

Retrieves a single DocumentField.

Parameters:

fieldName - the field name to retrieve document field metadata for. Cannot be null or empty.

Returns:

a DocumentField containing the metadata of the requested document

newDocumentFieldCollectionRequestBuilder

@Deprecated
DocumentFieldCollectionRequest.Builder newDocumentFieldCollectionRequestBuilder()

Deprecated.

as of 25R2.2, replaced by newDocumentFieldMetadataRequestBuilder()

Creates a DocumentFieldCollectionRequest.Builder.

Returns:

a DocumentFieldCollectionRequest.Builder

newDocumentFieldFilterBuilder

@Deprecated
DocumentFieldFilter.Builder newDocumentFieldFilterBuilder()

Deprecated.

as of 25R2.2, replaced by newDocumentFieldMetadataRequestBuilder()

Creates a DocumentFieldFilter.Builder.

Returns:

a DocumentFieldFilter.Builder

getFields

@Deprecated
DocumentFieldCollectionResponse getFields(DocumentFieldCollectionRequest request)

Deprecated.

as of 25R2.2, replaced by getDocumentFieldMetadata(DocumentFieldMetadataRequest)

Retrieves a DocumentFieldCollectionResponse.

Parameters:

request - the DocumentFieldCollectionRequest containing the information needed to retrieve the collection of document metadata. Cannot be null or empty.

Returns:

a DocumentFieldCollectionResponse containing the requested document metadata

getDocumentType

DocumentType getDocumentType(DocumentTypeRequest request)

Retrieves a single DocumentType.

Parameters:

request - the DocumentTypeRequest containing the information needed to retrieve the document metadata. Cannot be null or empty.

Returns:

a DocumentType containing the metadata of the requested document type

newDocumentTypeRequestBuilder

DocumentTypeRequest.Builder newDocumentTypeRequestBuilder()

Creates a DocumentTypeRequest.Builder.

Returns:

a DocumentTypeRequest.Builder

newDocumentFieldMetadataRequestBuilder

DocumentFieldMetadataRequest.Builder newDocumentFieldMetadataRequestBuilder()

Creates a DocumentFieldMetadataRequest.Builder.

Returns:

a DocumentFieldMetadataRequest.Builder

getDocumentFieldMetadata

DocumentFieldMetadataResponse getDocumentFieldMetadata(DocumentFieldMetadataRequest request)

Retrieves multiple DocumentFieldMetadata.

Parameters:

request - the DocumentFieldMetadataRequest containing the information needed to fetch the bulk DocumentFieldMetadata. Cannot be null or empty.

Returns:

a List of DocumentFieldMetadata containing the metadata of the requested fields