com.veeva.vault.sdk.api.data

Interface ObjectFormulaCurrencyFieldMetadata

All Superinterfaces:

ObjectFormulaFieldTypeMetadata

public interface ObjectFormulaCurrencyFieldMetadata
extends ObjectFormulaFieldTypeMetadata

Provides methods to retrieve common metadata on currency formula fields.

See Also:

ObjectFormulaFieldMetadata, ObjectFormulaFieldTypeMetadata

Method Summary

Modifier and Type	Method and Description
ObjectFormulaCurrencyFieldMetadataReturnType	getCurrencyType() Retrieves the ObjectFormulaCurrencyFieldMetadataReturnType of the given formula currency field.
BigDecimal	getMaximumValue() Retrieves the maximum value of the given formula currency field.
BigDecimal	getMinimumValue() Retrieves the minimum value of the given formula currency field.
int	getScale() Retrieves the scale of the given formula currency field.

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

getBaseFieldMetadata

Method Detail

getMaximumValue

BigDecimal getMaximumValue()

Retrieves the maximum value of the given formula currency field.

Returns:

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

getMinimumValue

BigDecimal getMinimumValue()

Retrieves the minimum value of the given formula currency field.

Returns:

the minimum value of the field. For example, -100000000000000000.

getScale

int getScale()

Retrieves the scale of the given formula currency field.

Returns:

the scale of the field. For example, 1.

getCurrencyType

ObjectFormulaCurrencyFieldMetadataReturnType getCurrencyType()

Retrieves the ObjectFormulaCurrencyFieldMetadataReturnType of the given formula currency field.

Returns:

the ObjectFormulaCurrencyFieldMetadataReturnType of the field. For example, ObjectFormulaCurrencyFieldMetadataReturnType.CORPORATE.