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

Interface ObjectPicklistFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectPicklistFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on picklist fields.

See Also:

• ObjectFieldMetadata

Method Summary

Modifier and Type	Method	Description
String	getControllingField()	Retrieves the name of the controlling field of the given picklist field.
DefaultValueExpressionMetadata	getDefaultValueExpression()	Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given picklist field.
String	getPicklistName()	Retrieves the picklist name used by the given picklist field.
boolean	hasControllingField()	Retrieves whether the given picklist field has a controlling field.
boolean	hasPicklistDependencies()	Retrieves whether the given picklist field has picklist dependencies.
boolean	isMultiValue()	Retrieves whether the given picklist field is a multi-value 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 picklist field.

Returns:

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

getPicklistName

String getPicklistName()

Retrieves the picklist name used by the given picklist field.

Returns:

the name of the picklist field. For example "picklist__c".

hasPicklistDependencies

boolean hasPicklistDependencies()

Retrieves whether the given picklist field has picklist dependencies.

Returns:

true if the field has picklist dependencies, otherwise false

isMultiValue

boolean isMultiValue()

Retrieves whether the given picklist field is a multi-value field.

Returns:

true if the field is a multi-value field, otherwise false

hasControllingField

boolean hasControllingField()

Retrieves whether the given picklist field has a controlling field.

Returns:

true if the field has a controlling field, otherwise false

getControllingField

String getControllingField()

Retrieves the name of the controlling field of the given picklist field.

Returns:

the name of the controlling field, otherwise empty. For example, "controlling_field__c".