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

Interface ObjectCurrencyFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectCurrencyFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on currency fields.

See Also:

• ObjectFieldMetadata

Method Summary

Modifier and Type	Method	Description
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given currency field.
BigDecimal	getMaximumValue()	Retrieves the maximum value of the given currency field.
BigDecimal	getMinimumValue()	Retrieves the minimum value of the given currency field.
String	getRelatedCorporateCurrencyField()	Retrieves the related Corporate Currency field name for the given currency field.
String	getRelatedLocalCurrencyField()	Retrieves the related Local Currency field name for the given currency field.
int	getScale()	Retrieves the scale of the given currency field.

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 default value expression of the given currency field.

Returns:

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

getMaximumValue

BigDecimal getMaximumValue()

Retrieves the maximum value of the given currency field.

Returns:

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

getMinimumValue

BigDecimal getMinimumValue()

Retrieves the minimum value of the given currency field.

Returns:

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

getRelatedCorporateCurrencyField

String getRelatedCorporateCurrencyField()

Retrieves the related Corporate Currency field name for the given currency field.

Returns:

the name of the related Corporate Currency field. For example, "corporate__c".

getRelatedLocalCurrencyField

String getRelatedLocalCurrencyField()

Retrieves the related Local Currency field name for the given currency field.

Returns:

the name of the related Local Currency field. For example, "local__c".

getScale

int getScale()

Retrieves the scale of the given currency field.

Returns:

the scale of the field. For example, 1.