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

Interface DocumentFieldMetadataRequest.Builder

Enclosing interface:

DocumentFieldMetadataRequest

public static interface DocumentFieldMetadataRequest.Builder

Creates an instance of DocumentFieldMetadataRequest.

Method Summary

Modifier and Type	Method	Description
DocumentFieldMetadataRequest	build()	Validates and retrieves a completed DocumentFieldMetadataRequest.
DocumentFieldMetadataRequest.Builder	withActiveOnly()	Optional: Sets a filter to retrieve active field attributes only.
DocumentFieldMetadataRequest.Builder	withDocumentType(DocumentType documentType)	Optional: Sets the DocumentType to use as a filter for the DocumentFieldMetadataRequest.
DocumentFieldMetadataRequest.Builder	withEditableOnly()	Optional: Sets a filter to only retrieve fields which the authenticated user has permission to edit.
DocumentFieldMetadataRequest.Builder	withFacetableOnly()	Optional: Sets a filter to retrieve facetable field attributes only.
DocumentFieldMetadataRequest.Builder	withFieldNames(List<String> fieldNames)	Optional: Sets the field names to use as filters for the DocumentFieldMetadataRequest.
DocumentFieldMetadataRequest.Builder	withRequiredOnly()	Optional: Sets a filter to retrieve required field attributes only.
DocumentFieldMetadataRequest.Builder	withSharedOnly()	Optional: Sets a filter to retrieve shared field attributes only.
DocumentFieldMetadataRequest.Builder	withVisibleOnly()	Optional: Sets a filter to only retrieve fields which the authenticated user has permission to view.

Method Details

withDocumentType

DocumentFieldMetadataRequest.Builder withDocumentType(DocumentType documentType)

Optional: Sets the DocumentType to use as a filter for the DocumentFieldMetadataRequest. When a DocumentType is passed in to a DocumentFieldMetadataRequest, only fields which are associated with the specified DocumentType are retrieved.

When omitted, retrieves fields from all available DocumentTypes.

Parameters:

documentType - the DocumentType to filter on. Document Type must exist.

Returns:

this DocumentFieldMetadataRequest.Builder

withFieldNames

DocumentFieldMetadataRequest.Builder withFieldNames(List<String> fieldNames)

Optional: Sets the field names to use as filters for the DocumentFieldMetadataRequest.

When omitted, retrieves all available fields.

Parameters:

fieldNames - the list of names of the fields. Cannot be null, empty, or contains duplicates. Fields must exist. For example, name__v.

Returns:

this DocumentFieldMetadataRequest.Builder

withActiveOnly

DocumentFieldMetadataRequest.Builder withActiveOnly()

Optional: Sets a filter to retrieve active field attributes only.

When omitted, retrieves active and inactive fields.

Returns:

this DocumentFieldMetadataRequest.Builder

withEditableOnly

DocumentFieldMetadataRequest.Builder withEditableOnly()

Optional: Sets a filter to only retrieve fields which the authenticated user has permission to edit.

When omitted, retrieves fields the authenticated user can and cannot edit.

Returns:

this DocumentFieldMetadataRequest.Builder

withVisibleOnly

DocumentFieldMetadataRequest.Builder withVisibleOnly()

Optional: Sets a filter to only retrieve fields which the authenticated user has permission to view.

When omitted, retrieves both fields the authenticated user has permission to view and fields hidden with field-level security>.

Returns:

this DocumentFieldMetadataRequest.Builder

withRequiredOnly

DocumentFieldMetadataRequest.Builder withRequiredOnly()

Optional: Sets a filter to retrieve required field attributes only.

When omitted, retrieves both required and optional fields.

Returns:

this DocumentFieldMetadataRequest.Builder

withSharedOnly

DocumentFieldMetadataRequest.Builder withSharedOnly()

Optional: Sets a filter to retrieve shared field attributes only.

When omitted, retrieves both shared and non-shared fields.

Returns:

this DocumentFieldMetadataRequest.Builder

withFacetableOnly

DocumentFieldMetadataRequest.Builder withFacetableOnly()

Optional: Sets a filter to retrieve facetable field attributes only.

When omitted, retrieves both facetable and non-facetable fields.

Returns:

this DocumentFieldMetadataRequest.Builder

build

DocumentFieldMetadataRequest build()

Validates and retrieves a completed DocumentFieldMetadataRequest.

Returns:

the completed DocumentFieldMetadataRequest