com.veeva.vault.sdk.api.data

Interface ObjectReferenceFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectReferenceFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on reference fields.

See Also:

ObjectFieldMetadata

Method Summary

Modifier and Type	Method and Description
boolean	allowInlineCreate() Retrieves whether the reference field allows inline create.
String	getControllingField() Retrieves the controlling field of the given reference field.
DefaultValueExpressionMetadata	getDefaultValueExpression() Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given object reference field.
String	getInboundRelationshipLabel() Retrieves the inbound relationship label of the given reference field.
String	getInboundRelationshipName() Retrieves the inbound relationship name of the given reference field.
String	getOutboundRelationshipName() Retrieves the outbound relationship name of the given reference field.
String	getReferencedObjectName() Retrieves the referenced object name of the given reference field.
String	getRelationshipCriteria() Retrieves the relationship criteria of the given reference field.
ObjectReferenceFieldMetadataDeleteType	getRelationshipDeleteType() Retrieves the ObjectReferenceFieldMetadataDeleteType of the given reference field.
boolean	hasControllingField() Retrieves whether the given reference field has a controlling field.
boolean	isSecureRelationship() Retrieves whether the reference field is a secure relationship.

Methods inherited from interface com.veeva.vault.sdk.api.data.ObjectFieldMetadata

getCreatedByUserId, getCreatedDate, getHelpContent, getLabel, getModifiedByUserId, getModifiedDate, getName, getObjectFieldMetadataType, getObjectName, getOrder, getSourceType, getTypedObjectFieldMetadata, getValueType, isActive, isCopyField, isEditable, isEncrypted, isFacetable, isListColumn, isRequired, isUnique

Method Detail

getDefaultValueExpression

DefaultValueExpressionMetadata getDefaultValueExpression()

Retrieves the DefaultValueExpressionMetadata containing the default value expression of the given object reference field.

Returns:

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

getInboundRelationshipLabel

String getInboundRelationshipLabel()

Retrieves the inbound relationship label of the given reference field.

Returns:

the inbound relationship label of the field. For example, "inbound label".

getInboundRelationshipName

String getInboundRelationshipName()

Retrieves the inbound relationship name of the given reference field.

Returns:

the inbound relationship name of the field. For example, "inbound__cr".

getOutboundRelationshipName

String getOutboundRelationshipName()

Retrieves the outbound relationship name of the given reference field.

Returns:

the outbound relationship name of the field. For example, "outbound__cr".

getRelationshipCriteria

String getRelationshipCriteria()

Retrieves the relationship criteria of the given reference field.

Returns:

the relationship criteria of the field. For example, "currency__c = {{this.local_currency__c}}".

getRelationshipDeleteType

ObjectReferenceFieldMetadataDeleteType getRelationshipDeleteType()

Retrieves the ObjectReferenceFieldMetadataDeleteType of the given reference field.

Returns:

the ObjectReferenceFieldMetadataDeleteType type of the given field if it exists, otherwise null. For example, ObjectReferenceFieldMetadataDeleteType.BLOCK.

getReferencedObjectName

String getReferencedObjectName()

Retrieves the referenced object name of the given reference field.

Returns:

the referenced object name of the field. For example, "referenced_obj__c".

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.

Returns:

the name of the field's controlling field. For example, "controlling_field__c".

allowInlineCreate

boolean allowInlineCreate()

Retrieves whether the reference field allows inline create.

Returns:

true if the field allows inline create, otherwise false

isSecureRelationship

boolean isSecureRelationship()

Retrieves whether the reference field is a secure relationship.

Returns:

true if the field is a secure relationship, otherwise false