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

Interface ObjectEmailFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectEmailFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on email fields.

See Also:

• ObjectFieldMetadata

Method Summary

Modifier and Type	Method	Description
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given email field.
FormatMaskExpressionMetadata	getFormatMask()	Retrieves the FormatMaskExpressionMetadata containing the format mask expression of the given email field.
int	getMaxLength()	Retrieves the maximum character length of the given email field.
boolean	isSystemManaged()	Retrieves whether the given email 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 email 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 email field.

Returns:

a FormatMaskExpressionMetadata with the format mask expression of EmailFormat()

getMaxLength

int getMaxLength()

Retrieves the maximum character length of the given email field.

Returns:

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

isSystemManaged

boolean isSystemManaged()

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

Returns:

true if the field is system-managed, otherwise false