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

Interface ObjectBitmaskFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectBitmaskFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on bitmask fields.

See Also:

• ObjectFieldMetadata

Method Summary

Modifier and Type	Method	Description
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the default value expression (default_value) of the given bitmask field.
BigInteger	getMaximumValue()	Retrieves the maximum value (max_value) of the given bitmask field.
BigInteger	getMinimumValue()	Retrieves the minimum value (min_value) of the given bitmask 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, isSystemManaged, isUnique

Method Details

getDefaultValueExpression

DefaultValueExpressionMetadata getDefaultValueExpression()

Retrieves the DefaultValueExpressionMetadata containing the default value expression (default_value) of the given bitmask field.

Returns:

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

getMaximumValue

BigInteger getMaximumValue()

Retrieves the maximum value (max_value) of the given bitmask field.

Returns:

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

getMinimumValue

BigInteger getMinimumValue()

Retrieves the minimum value (min_value) of the given bitmask field.

Returns:

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