Package com.veeva.vault.sdk.api.data
Interface ObjectRollupNumberFieldMetadata
- All Superinterfaces:
ObjectRollupFieldTypeMetadata
Provides methods to retrieve common metadata on number Roll-up fields.
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves theFormatMaskExpressionMetadatacontaining the format mask expression of the given number Roll-up field.Retrieves the maximum value of the given number Roll-up field.Retrieves the minimum value of the given number Roll-up field.intgetScale()Retrieves the scale of the given number Roll-up field.Methods inherited from interface com.veeva.vault.sdk.api.data.ObjectRollupFieldTypeMetadata
getBaseFieldMetadata
-
Method Details
-
getFormatMask
FormatMaskExpressionMetadata getFormatMask()Retrieves theFormatMaskExpressionMetadatacontaining the format mask expression of the given number Roll-up field.- Returns:
- a FormatMaskExpressionMetadata instance with the format mask expression if it exists, otherwise null
-
getMaximumValue
BigDecimal getMaximumValue()Retrieves the maximum value of the given number Roll-up field. For example, 100.- Returns:
- the maximum value of the field
-
getMinimumValue
BigDecimal getMinimumValue()Retrieves the minimum value of the given number Roll-up field. For example, 1.- Returns:
- the minimum value of the field
-
getScale
int getScale()Retrieves the scale of the given number Roll-up field. For example, 1.- Returns:
- the scale of the field
-