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

Interface ObjectTextFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectTextFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on text fields.

See Also:

• ObjectFieldMetadata

Method Summary

Modifier and Type	Method	Description
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given text field.
String	getDisplayFormat()	Deprecated. as of 24R3.4, replaced by getValueFormat()
FormatMaskExpressionMetadata	getFormatMask()	Retrieves the FormatMaskExpressionMetadata containing the format mask expression of the given text field.
int	getMaxLength()	Retrieves the max length value of the given text field.
String	getValueFormat()	Retrieves the value format on the given text field.
boolean	isSystemManaged()	Retrieves whether the given text field is a system-managed 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 text field.

Returns:

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

getFormatMask

FormatMaskExpressionMetadata getFormatMask()

Retrieves the FormatMaskExpressionMetadata containing the format mask expression of the given text field.

Returns:

a FormatMaskExpressionMetadata with the format mask expression if it exists, otherwise null

getMaxLength

int getMaxLength()

Retrieves the max length value of the given text field.

Returns:

the max length of the field. For example, 100.

isSystemManaged

boolean isSystemManaged()

Retrieves whether the given text field is a system-managed field.

Returns:

true if the field is system-managed, otherwise false

getDisplayFormat

@Deprecated
String getDisplayFormat()

Deprecated.

as of 24R3.4, replaced by getValueFormat()

Retrieves the display format on the given text field. Only system-managed object text fields can have a display format. Throws an exception if the field is not system-managed.

Returns:

the display format of a system-managed text field if it exists. For example, "VV-{XXXXXX}". Otherwise, throw an exception.

getValueFormat

String getValueFormat()

Retrieves the value format on the given text field. Only system-managed object text fields can have a value format. Throws an exception if the field is not system-managed.

Returns:

the value format of a system-managed text field if it exists. For example, "VV-{XXXXXX}". Otherwise, throw an exception.