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

Interface ObjectPercentFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectPercentFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on percent fields.

See Also:

• ObjectFieldMetadata

Method Summary

Modifier and Type	Method	Description
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the expression for the default value of the given percent field.
FormatMaskExpressionMetadata	getFormatMask()	Retrieves the FormatMaskExpressionMetadata containing the expression for the format mask of the given percent field.
BigDecimal	getMaximumValue()	Retrieves the maximum value of the given percent field.
BigDecimal	getMinimumValue()	Retrieves the minimum value of the given percent field.
int	getScale()	Retrieves the scale of the given percent field, which is the number of allowed decimal places.

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

getCreatedByUserId, getCreatedDate, getDescription, 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 expression for the default value of the given percent field.

Returns:

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

getFormatMask

FormatMaskExpressionMetadata getFormatMask()

Retrieves the FormatMaskExpressionMetadata containing the expression for the format mask of the given percent field.

Returns:

a FormatMaskExpressionMetadata with the format mask expression of PercentFormat()

getMaximumValue

BigDecimal getMaximumValue()

Retrieves the maximum value of the given percent field.

Returns:

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

getMinimumValue

BigDecimal getMinimumValue()

Retrieves the minimum value of the given percent field.

Returns:

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

getScale

int getScale()

Retrieves the scale of the given percent field, which is the number of allowed decimal places. Trailing zeroes are not displayed. For example, for a field with a value of 3.14, a scale of 0 would display 3, a scale of 2 would display 3.14, and a scale of 3 would display 3.14.

Returns:

the scale of the field. For example, 3.