Package com.veeva.vault.sdk.api.document

Interface DocumentFormulaFieldMetadata

All Superinterfaces:

DocumentFieldMetadata

public interface DocumentFormulaFieldMetadata
extends DocumentFieldMetadata

Provides methods to retrieve metadata specific to and shared by all Formula fields.

See Also:

• DocumentFieldMetadata

Method Summary

Modifier and Type	Method	Description
DocumentFormulaFieldExpressionMetadata	getFormulaExpression()	Retrieves the formula expression of the given Formula field.
DocumentFormulaFieldType	getFormulaFieldType()	Retrieves the return type of the formula field.
<T extends DocumentFormulaFieldTypeMetadata> T	getFormulaTypeMetadata(Class<T> formulaMetadataClass)	Retrieves a subclass of DocumentFormulaFieldTypeMetadata.
DocumentFormulaFieldMissingValueBehaviorType	getMissingFieldValueBehaviorType()	Retrieves the DocumentFormulaFieldMissingValueBehaviorType of the given formula field.

Methods inherited from interface com.veeva.vault.sdk.api.document.DocumentFieldMetadata

getDocumentFieldMetadataType, getHelpContent, getLabel, getName, getSourceType, getTypedDocumentFieldMetadata, getValueType, isActive, isCopyField, isEditable, isFacetable, isQueryable, isRequired, isShared, isVisible

Method Details

getFormulaExpression

DocumentFormulaFieldExpressionMetadata getFormulaExpression()

Retrieves the formula expression of the given Formula field.

Returns:

the formula expression of the field

getFormulaFieldType

DocumentFormulaFieldType getFormulaFieldType()

Retrieves the return type of the formula field. The return type is represented by the DocumentFormulaFieldType enum, which includes values such as DocumentFormulaFieldType.BOOLEAN, DocumentFormulaFieldType.DATE, DocumentFormulaFieldType.DATETIME, DocumentFormulaFieldType.NUMBER, and DocumentFormulaFieldType.TEXT.

Returns:

the DocumentFormulaFieldType of the formula field

getFormulaTypeMetadata

<T extends DocumentFormulaFieldTypeMetadata> T getFormulaTypeMetadata(Class<T> formulaMetadataClass)

Retrieves a subclass of DocumentFormulaFieldTypeMetadata. For example, DocumentFormulaTextFieldMetadata. This allows you to fetch the formula type field attributes of the given formula field.

Parameters:

formulaMetadataClass - a subclass of DocumentFormulaFieldTypeMetadata. For example, DocumentFormulaTextFieldMetadata.

Returns:

A subclass of DocumentFormulaFieldTypeMetadata of the formula field

getMissingFieldValueBehaviorType

DocumentFormulaFieldMissingValueBehaviorType getMissingFieldValueBehaviorType()

Retrieves the DocumentFormulaFieldMissingValueBehaviorType of the given formula field. For example, DocumentFormulaFieldMissingValueBehaviorType.EMPTY.

Returns:

the DocumentFormulaFieldMissingValueBehaviorType of the field