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
DocumentType	getDocumentType(DocumentTypeRequest request)	Retrieves a single DocumentType.
DocumentField	getField(String fieldName)	Retrieves a single DocumentField.
DocumentFieldCollectionResponse	getFields(DocumentFieldCollectionRequest request)	Retrieves a DocumentFieldCollectionResponse.
DocumentFieldCollectionRequest.Builder	newDocumentFieldCollectionRequestBuilder()	Creates a DocumentFieldCollectionRequest.Builder.
DocumentFieldFilter.Builder	newDocumentFieldFilterBuilder()	Creates a DocumentFieldFilter.Builder.
DocumentTypeRequest.Builder	newDocumentTypeRequestBuilder()	Creates a DocumentTypeRequest.Builder.

Method Details

getField

DocumentField getField(String fieldName)

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

DocumentFieldCollectionRequest.Builder newDocumentFieldCollectionRequestBuilder()

Creates a DocumentFieldCollectionRequest.Builder.

Returns:

a DocumentFieldCollectionRequest.Builder

newDocumentFieldFilterBuilder

DocumentFieldFilter.Builder newDocumentFieldFilterBuilder()

Creates a DocumentFieldFilter.Builder.

Returns:

a DocumentFieldFilter.Builder

getFields

DocumentFieldCollectionResponse getFields(DocumentFieldCollectionRequest request)

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