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.
DocumentFieldMetadataRequest.Builder	withEditableOnly()	Optional: sets a filter to only retrieve fields which the current 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.
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 current user has permission to view.

Method Details

withDocumentType

DocumentFieldMetadataRequest.Builder withDocumentType(DocumentType documentType)

Optional: Sets the DocumentType. When omitted, retrieves all fields.

Parameters:

documentType - the DocumentType. Document Type must exist.

Returns:

this DocumentFieldMetadataRequest.Builder

withFieldNames

DocumentFieldMetadataRequest.Builder withFieldNames(List<String> fieldNames)

Optional: Sets the field names.

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 all field attributes.

Returns:

this DocumentFieldMetadataRequest.Builder

withEditableOnly

DocumentFieldMetadataRequest.Builder withEditableOnly()

Optional: sets a filter to only retrieve fields which the current user has permission to edit. When omitted, retrieves both editable and non-editable fields.

Returns:

this DocumentFieldMetadataRequest.Builder

withVisibleOnly

DocumentFieldMetadataRequest.Builder withVisibleOnly()

Optional: sets a filter to only retrieve fields which the current user has permission to view. When omitted, retrieves both viewable and hidden fields.

Returns:

this DocumentFieldMetadataRequest.Builder

withRequiredOnly

DocumentFieldMetadataRequest.Builder withRequiredOnly()

Optional: Sets a filter to retrieve required field attributes only. When omitted, retrieves all field attributes.

Returns:

this DocumentFieldMetadataRequest.Builder

withSharedOnly

DocumentFieldMetadataRequest.Builder withSharedOnly()

Optional: Sets a filter to retrieve shared field attributes only. When omitted, retrieves all field attributes.

Returns:

this DocumentFieldMetadataRequest.Builder

withFacetableOnly

DocumentFieldMetadataRequest.Builder withFacetableOnly()

Optional: Sets a filter to retrieve facetable field attributes only. When omitted, retrieves all field attributes.

Returns:

this DocumentFieldMetadataRequest.Builder

build

DocumentFieldMetadataRequest build()

Validates and retrieves a completed DocumentFieldMetadataRequest.

Returns:

the completed DocumentFieldMetadataRequest