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

Interface DocumentObjectReferenceFieldMetadata

All Superinterfaces:

DocumentFieldMetadata

public interface DocumentObjectReferenceFieldMetadata
extends DocumentFieldMetadata

Provides methods to retrieve metadata specific to and shared by all Object Reference fields.

See Also:

• DocumentFieldMetadata

Method Summary

Modifier and Type	Method	Description
String	getControllingField()	Retrieves the controlling field of the given reference field if applicable.
List<DocumentRelationshipCriteriaExpressionMetadata>	getDocumentRelationshipCriteriaExpressions()	Retrieves the VQL relationship criteria expressions constraining the given reference field.
String	getReferencedObjectName()	Retrieves the referenced object name of the given object reference field.
boolean	hasControllingField()	Retrieves whether the given reference field has a controlling field.
boolean	isMultiValue()	Retrieves whether the given reference field is a multi-value field.
boolean	isSecureRelationship()	Retrieves whether the reference field supports relationship security.

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

getReferencedObjectName

String getReferencedObjectName()

Retrieves the referenced object name of the given object reference field. For example, referenced_obj__c.

Returns:

the referenced object name of the field

isMultiValue

boolean isMultiValue()

Retrieves whether the given reference 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 reference field has a controlling field.

Returns:

true if the field has a controlling field, otherwise false

getControllingField

String getControllingField()

Retrieves the controlling field of the given reference field if applicable. For example, controlling_field__c. This method will return null when hasControllingField() is false.

Returns:

the name of the field's controlling field

getDocumentRelationshipCriteriaExpressions

List<DocumentRelationshipCriteriaExpressionMetadata> getDocumentRelationshipCriteriaExpressions()

Retrieves the VQL relationship criteria expressions constraining the given reference field. For example, currency__c = {{this.local_currency__c}}.

Returns:

the list of relationship criteria expressions of the field

isSecureRelationship

boolean isSecureRelationship()

Retrieves whether the reference field supports relationship security.

Returns:

true if the field supports secure relationships, otherwise false