com.veeva.vault.sdk.api.data

Interface ObjectDocumentReferenceFieldMetadata

All Superinterfaces:

ObjectFieldMetadata

public interface ObjectDocumentReferenceFieldMetadata
extends ObjectFieldMetadata

Provides methods to retrieve common metadata on document reference fields.

See Also:

ObjectFieldMetadata

Method Summary

Modifier and Type	Method and Description
boolean	allowInlineCreate() Retrieves whether the document reference field allows inline create.
String	getInboundRelationshipLabel() Retrieves the inbound relationship label of the given document reference field.
String	getInboundRelationshipName() Retrieves the inbound relationship name of the given document reference field.
String	getOutboundRelationshipName() Retrieves the outbound relationship name of the given document reference field.
String	getReferencedObjectName() Retrieves the referenced object name of the given document reference field.
String	getRelationshipCriteria() Retrieves the relationship criteria of the given document reference field.
ObjectReferenceFieldMetadataDeleteType	getRelationshipDeleteType() Retrieves the ObjectReferenceFieldMetadataDeleteType of the given document reference field.
ObjectDocumentReferenceFieldMetadataVersionType	getVersionType() Retrieves the ObjectDocumentReferenceFieldMetadataVersionType of the given document reference field.
boolean	isSecureRelationship() Retrieves whether the document 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

getInboundRelationshipLabel

String getInboundRelationshipLabel()

Retrieves the inbound relationship label of the given document 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 document 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 document reference field.

Returns:

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

getRelationshipCriteria

String getRelationshipCriteria()

Retrieves the relationship criteria of the given document 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 document 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 document reference field.

Returns:

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

allowInlineCreate

boolean allowInlineCreate()

Retrieves whether the document reference field allows inline create.

Returns:

true if the field allows inline create, otherwise false

isSecureRelationship

boolean isSecureRelationship()

Retrieves whether the document reference field is a secure relationship.

Returns:

true if the field is a secure relationship, otherwise false

getVersionType

ObjectDocumentReferenceFieldMetadataVersionType getVersionType()

Retrieves the ObjectDocumentReferenceFieldMetadataVersionType of the given document reference field.

Returns:

the ObjectDocumentReferenceFieldMetadataVersionType of the field. For example, ObjectDocumentReferenceFieldMetadataVersionType.LATEST_VERSION.