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

Interface ObjectLinkFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectLinkFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on link fields.

See Also:

• ObjectFieldMetadata

Method Summary

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

Method Details

getDefaultValueExpression

DefaultValueExpressionMetadata getDefaultValueExpression()

Retrieves the DefaultValueExpressionMetadata containing the expression for the default value (default_value) of the given link 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 (format_mask) of the given link field.

Returns:

a FormatMaskExpressionMetadata with the format mask expression of LinkFormat()

getMaxLength

int getMaxLength()

Retrieves the maximum character length (max_length) of the given link field.

Returns:

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