Package com.veeva.vault.sdk.api.data

Interface ObjectUnboundDocumentFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectUnboundDocumentFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on unbound document fields.

See Also:

• ObjectFieldMetadata

Method Summary

Modifier and Type	Method	Description
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given unbound document field.
BigDecimal	getMaximumValue()	Retrieves the maximum value of the given unbound document field.
BigDecimal	getMinimumValue()	Retrieves the minimum value of the given unbound document field.
String	getRelatedDocument()	Retrieves the related document field of the given unbound document field.

Methods inherited from interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata

getCreatedByUserId, getCreatedDate, getHelpContent, getLabel, getModifiedByUserId, getModifiedDate, getName, getObjectFieldMetadataType, getObjectName, getOrder, getSourceType, getTypedObjectFieldMetadata, getValueType, isActive, isCopyField, isEditable, isEncrypted, isFacetable, isListColumn, isRequired, isUnique

Method Details

getDefaultValueExpression

DefaultValueExpressionMetadata getDefaultValueExpression()

Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given unbound document field.

Returns:

a DefaultValueExpressionMetadata with a default value expression if it exists, otherwise null

getMaximumValue

BigDecimal getMaximumValue()

Retrieves the maximum value of the given unbound document field.

Returns:

the maximum value of the field. For example, 100.

getMinimumValue

BigDecimal getMinimumValue()

Retrieves the minimum value of the given unbound document field.

Returns:

the minimum value of the field. For example, 1.

getRelatedDocument

String getRelatedDocument()

Retrieves the related document field of the given unbound document field.

Returns:

the name of the related document field. For example "my_document_field__c".