Package com.veeva.vault.sdk.api.document

Interface DocumentLookupFieldMetadata

All Superinterfaces:

DocumentFieldMetadata

public interface DocumentLookupFieldMetadata
extends DocumentFieldMetadata

Provides methods to retrieve common metadata on lookup fields.

See Also:

• DocumentFieldMetadata

Method Summary

Modifier and Type	Method	Description
DocumentLookupFieldType	getLookupFieldType()	Retrieves the DocumentLookupFieldType of the given lookup field.
<T extends DocumentLookupFieldTypeMetadata> T	getLookupTypeMetadata(Class<T> lookupMetadataClass)	Retrieves a subclass of DocumentLookupFieldTypeMetadata so you can fetch the lookup type field attributes of the given lookup field.
String	getSourceField()	Retrieves the source field of the given lookup field.
String	getSourceObjectName()	Retrieves the source object of the given lookup field.

Methods inherited from interface com.veeva.vault.sdk.api.document.DocumentFieldMetadata

getDocumentFieldMetadataType, getHelpContent, getLabel, getName, getSourceType, getTypedDocumentFieldMetadata, getValueType, isActive, isCopyField, isEditable, isFacetable, isQueryable, isRequired, isShared, isVisible

Method Details

getSourceField

String getSourceField()

Retrieves the source field of the given lookup field.

Returns:

the source field that this field is looking up. For example, "source_field__c".

getSourceObjectName

String getSourceObjectName()

Retrieves the source object of the given lookup field.

Returns:

the source object that this field is looking up. For example, "source_object__c".

getLookupFieldType

DocumentLookupFieldType getLookupFieldType()

Retrieves the DocumentLookupFieldType of the given lookup field.

Returns:

the DocumentLookupFieldType of the field. For example, DocumentLookupFieldType.PICKLIST.

getLookupTypeMetadata

<T extends DocumentLookupFieldTypeMetadata> T getLookupTypeMetadata(Class<T> lookupMetadataClass)

Retrieves a subclass of DocumentLookupFieldTypeMetadata so you can fetch the lookup type field attributes of the given lookup field.

Parameters:

lookupMetadataClass - a subclass of DocumentLookupFieldTypeMetadata. For example, ObjectLookupTextFieldMetadata.class.

Returns:

A subclass of DocumentLookupFieldTypeMetadata of the field. For example, DocumentLookupPicklistFieldMetadata.