Interface ObjectRollupNumberFieldMetadata

All Superinterfaces:
ObjectRollupFieldTypeMetadata

public interface ObjectRollupNumberFieldMetadata extends ObjectRollupFieldTypeMetadata
Provides methods to retrieve common metadata on number Roll-up fields.
See Also:
  • Method Details

    • getFormatMask

      Retrieves the FormatMaskExpressionMetadata containing 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