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

Interface DocumentNumberFieldMetadata

All Superinterfaces:

DocumentFieldMetadata

public interface DocumentNumberFieldMetadata
extends DocumentFieldMetadata

Provides methods to retrieve common metadata on number fields.

See Also:

• DocumentFieldMetadata

Method Summary

Modifier and Type	Method	Description
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given Number field.
BigDecimal	getMaximumValue()	Retrieves the maximum value of the given number field.
BigDecimal	getMinimumValue()	Retrieves the minimum value of the given number field.
int	getScale()	Retrieves the scale of the given number field.

Methods inherited from interface com.veeva.vault.sdk.api.document.DocumentFieldMetadata

getDocumentFieldMetadataType, getHelpContent, getLabel, getName, getSourceType, getTypedDocumentFieldMetadata, getValueType, isActive, isCopyField, isEditable, isFacetable, isQueryable, isRequired, isShared, isVisible

Method Details

getDefaultValueExpression

DefaultValueExpressionMetadata getDefaultValueExpression()

Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given Number field.

Returns:

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

getMaximumValue

BigDecimal getMaximumValue()

Retrieves the maximum value of the given number field.

Returns:

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

getMinimumValue

BigDecimal getMinimumValue()

Retrieves the minimum value of the given number field.

Returns:

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

getScale

int getScale()

Retrieves the scale of the given number field.

Returns:

the scale of the field. For example, 1.