Package com.veeva.vault.sdk.api.data
Interface ObjectFieldMetadata
- All Known Subinterfaces:
ObjectAttachmentFieldMetadata,ObjectBitmaskFieldMetadata,ObjectBooleanFieldMetadata,ObjectComponentFieldMetadata,ObjectCurrencyFieldMetadata,ObjectDateFieldMetadata,ObjectDateTimeFieldMetadata,ObjectDocumentReferenceFieldMetadata,ObjectEmailFieldMetadata,ObjectFormulaFieldMetadata,ObjectIdFieldMetadata,ObjectLinkFieldMetadata,ObjectLongTextFieldMetadata,ObjectLookupFieldMetadata,ObjectNumberFieldMetadata,ObjectParentReferenceFieldMetadata,ObjectPercentFieldMetadata,ObjectPhoneFieldMetadata,ObjectPicklistFieldMetadata,ObjectReferenceFieldMetadata,ObjectRichTextFieldMetadata,ObjectRollupFieldMetadata,ObjectTextFieldMetadata,ObjectTimeFieldMetadata,ObjectUnboundDocumentFieldMetadata
public interface ObjectFieldMetadata
Provides methods to retrieve common metadata on the specified object field.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves the user that created the given object field.Retrieves the date that the given object field was created.Retrieves the description (description) of the given object field.Retrieves the help content (help_content) of the given object field.getLabel()Retrieves the label (label) of the given object field in the current user's language.Retrieves the ID of the most recent user that modified the given object field.Retrieves the date that the given object field was last modified.getName()Retrieves the name of the given object field.Retrieves theObjectFieldMetadataType(type) of the given object field.Retrieves the object name of the given object field.intgetOrder()Retrieves the display order (order) of the given object field.Retrieves theSourceTypeof the given object field.<T extends ObjectFieldMetadata>
TgetTypedObjectFieldMetadata(Class<T> metadataClass) Retrieves a subclass ofObjectFieldMetadata.Retrieves theValueTypeof the given object field.booleanisActive()Checks whether the given object field status is active (active).booleanChecks whether the given field is a copy field (no_copy = false).booleanDeprecated.booleanChecks whether the given field is encrypted (encrypted).booleanChecks whether the given object field is facetable.booleanChecks whether the field should be displayed by default in the object record list view, object record hover card, and object lookup dialog (list_column).booleanChecks whether the given field is a required field (required).booleanChecks whether the given field is system-managed (editable = false).booleanisUnique()Checks whether the given field is a unique field (unique).
-
Method Details
-
getName
String getName()Retrieves the name of the given object field. For example, "name__v".- Returns:
- the non-null field name
-
getSourceType
SourceType getSourceType()Retrieves theSourceTypeof the given object field. For example,SourceType.STANDARD.- Returns:
- the
SourceTypeof the field - See Also:
-
getLabel
String getLabel()Retrieves the label (label) of the given object field in the current user's language. For example,"Name".- Returns:
- the label value of the field
-
getObjectFieldMetadataType
ObjectFieldMetadataType getObjectFieldMetadataType()Retrieves theObjectFieldMetadataType(type) of the given object field. For example,ObjectFieldMetadataType.TEXT.- Returns:
- the
ObjectFieldMetadataTypeof the field - See Also:
-
getTypedObjectFieldMetadata
Retrieves a subclass ofObjectFieldMetadata. This allows you to fetch the type field attributes of the given object field. For example,ObjectTextFieldMetadata.- Returns:
- a subclass of
ObjectFieldMetadatafor the field
-
getValueType
ValueType getValueType()Retrieves theValueTypeof the given object field. For example,ValueType.NUMBER.- Returns:
- the non-null
ValueType - See Also:
-
isActive
boolean isActive()Checks whether the given object field status is active (active).- Returns:
- true if the field is active, otherwise false
-
getDescription
String getDescription()Retrieves the description (description) of the given object field. This description appears in the Admin UI to assist in object configuration and is not visible to users. For example, "Used when users select records in a dropdown."- Returns:
- description specified on the field
-
isRequired
boolean isRequired()Checks whether the given field is a required field (required).- Returns:
- true if the field is required, otherwise false
-
isUnique
boolean isUnique()Checks whether the given field is a unique field (unique).- Returns:
- true if the field is unique, otherwise false
-
getHelpContent
String getHelpContent()Retrieves the help content (help_content) of the given object field. This help content appears in the Vault UI to assist users in creating object records. For example, "Enter the most recent result."- Returns:
- help content specified on the field
-
isListColumn
boolean isListColumn()Checks whether the field should be displayed by default in the object record list view, object record hover card, and object lookup dialog (list_column).- Returns:
- true if the field is displayed, otherwise false
-
getOrder
int getOrder()Retrieves the display order (order) of the given object field. For example,1.- Returns:
- the display order of the field
-
isCopyField
boolean isCopyField()Checks whether the given field is a copy field (no_copy = false).- Returns:
- true if the field is a copy field, otherwise false
-
isEncrypted
boolean isEncrypted()Checks whether the given field is encrypted (encrypted).- Returns:
- true if the field is encrypted, otherwise false
-
isSystemManaged
boolean isSystemManaged()Checks whether the given field is system-managed (editable = false).- Returns:
- true if the field is system-managed, otherwise false
-
isEditable
Deprecated.as of 26R1.3, replaced byisSystemManaged(). Existing calls should be migrated to!isSystemManaged()Checks whether the given object field is editable based on the current user's permissions. When the field is a system-managed field, this value is always false regardless of whether the user can edit the field. When true, the field value can be defined by the currently authenticated user. When false, the field value is read-only or system-managed.- Returns:
- true if the field is not system-managed and is editable by the user, otherwise false
-
isFacetable
boolean isFacetable()Checks whether the given object field is facetable. When true, the field is available for use as a faceted filter in the Vault UI.- Returns:
- true if the field is facetable, otherwise false
-
getCreatedByUserId
String getCreatedByUserId()Retrieves the user that created the given object field. For example,"1000001".- Returns:
- the ID of the user who created the field
-
getCreatedDate
ZonedDateTime getCreatedDate()Retrieves the date that the given object field was created. For example,2023-04-11T18:54:01.000Z.- Returns:
- the date that the field was created
-
getModifiedByUserId
String getModifiedByUserId()Retrieves the ID of the most recent user that modified the given object field. For example,"1000001".- Returns:
- the ID of the most recent user who modified the field
-
getModifiedDate
ZonedDateTime getModifiedDate()Retrieves the date that the given object field was last modified. For example,2023-04-11T18:54:01.000Z.- Returns:
- the date that the field was last modified
-
getObjectName
String getObjectName()Retrieves the object name of the given object field. For example,"study__v".- Returns:
- the name of the object this field is associated with
-
isSystemManaged().