com.veeva.vault.sdk.api.data

Interface ObjectFormulaFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectFormulaFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on formula fields.

See Also:

ObjectFieldMetadata

Method Summary

Modifier and Type	Method and Description
ObjectFormulaFieldExpressionMetadata	getFormulaExpression() Retrieves the ObjectFormulaFieldExpressionMetadata containing the formula expression of the given formula field.
ObjectFormulaFieldMissingValueBehaviorType	getMissingFieldValueBehaviorType() Retrieves the ObjectFormulaFieldMissingValueBehaviorType of the given formula field.
<T extends ObjectFormulaFieldTypeMetadata> T	getObjectFormulaTypeMetadata(Class<T> formulaMetadataClass) Retrieves a subclass of ObjectFormulaFieldTypeMetadata so you can fetch the formula type field attributes of the given formula field.
ObjectFormulaFieldType	getType() Retrieves the ObjectFormulaFieldType of the given formula field.

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

getCreatedByUserId, getCreatedDate, getHelpContent, getLabel, getModifiedByUserId, getModifiedDate, getName, getObjectFieldMetadataType, getObjectName, getOrder, getSourceType, getTypedObjectFieldMetadata, getValueType, isActive, isCopyField, isEditable, isEncrypted, isFacetable, isListColumn, isRequired, isUnique

Method Detail

getFormulaExpression

ObjectFormulaFieldExpressionMetadata getFormulaExpression()

Retrieves the ObjectFormulaFieldExpressionMetadata containing the formula expression of the given formula field.

Returns:

an ObjectFormulaFieldExpressionMetadata with a formula expression

getObjectFormulaTypeMetadata

<T extends ObjectFormulaFieldTypeMetadata> T getObjectFormulaTypeMetadata(Class<T> formulaMetadataClass)

Retrieves a subclass of ObjectFormulaFieldTypeMetadata so you can fetch the formula type field attributes of the given formula field.

Parameters:

formulaMetadataClass - a subclass of ObjectFormulaFieldTypeMetadata. For example, ObjectFormulaTextFieldMetadata.class.

Returns:

A subclass of ObjectFormulaFieldTypeMetadata of the field. For example, ObjectFormulaTextFieldMetadata.

getType

ObjectFormulaFieldType getType()

Retrieves the ObjectFormulaFieldType of the given formula field.

Returns:

the ObjectFormulaFieldType of the field. For example, ObjectFormulaFieldType.TEXT.

getMissingFieldValueBehaviorType

ObjectFormulaFieldMissingValueBehaviorType getMissingFieldValueBehaviorType()

Retrieves the ObjectFormulaFieldMissingValueBehaviorType of the given formula field.

Returns:

the ObjectFormulaFieldMissingValueBehaviorType of the field. For example, ObjectFormulaFieldMissingValueBehaviorType.EMPTY.