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

Interface ObjectPhoneFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectPhoneFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on phone fields.

See Also:

• ObjectFieldMetadata

Method Summary

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

Returns:

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

getFormatMask

FormatMaskExpressionMetadata getFormatMask()

Retrieves the FormatMaskExpressionMetadata containing the expression for the format mask of the given phone field.

Returns:

a FormatMaskExpressionMetadata with the format mask expression of PhoneFormat()

getMaxLength

int getMaxLength()

Retrieves the maximum character length of the given phone field.

Returns:

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

isSystemManaged

boolean isSystemManaged()

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

Returns:

true if the field is system-managed, otherwise false