Package com.veeva.vault.sdk.api.integration

Interface FieldRule

public interface FieldRule
Provides methods to retrieve information related to a FieldRule. This is a contract object for the Fieldrule subcomponent under Integrationrule.

  • Method Details

    • getName

      String getName()
      Retrieve the FieldRule name. By default, this value is target_object_field or target_docfield, without an __c suffix. FieldRule names must be unique. If two FieldRules have the same name, Vault adds a trailing number to the end of the name. For example, target_object_field1.
      Returns:
      rule name

    • getLabel

      String getLabel()
      Retrieves this FieldRule label. This value may be null.
      Returns:
      rule label

    • getTargetObjectField

      String getTargetObjectField()
      Retrieves the name of the target object field. This is the subcomponent reference to an object field. This field cannot be null if target_object is set. For example, required__v.
      Returns:
      name of subcomponent

    • getTargetObject

      String getTargetObject()
      Retrieves the name of the target Vault object. For example, Product.
      Returns:
      name of the Vault object, or null if the target is not a Vault object

    • getTargetDocfield

      String getTargetDocfield()
      Retrieves the reference to a document field, if target is a document. For example, annotations_all__v.
      Returns:
      name of docfield, or null if the target is not a document

    • getTargetObjFieldRefObj

      String getTargetObjFieldRefObj()
      Retrieves the name of the Vault object that the target object field references, if the target_object_field is an object reference field as specified in the field rule.

      The target_object_field is a field on the target_object.

      Returns:
      the name of the Vault object being referenced by the target_object_field, or null if not specified or if the target field is not an object reference field.

    • getTargetFieldLookup

      String getTargetFieldLookup()
      Retrieves the value of the target_field_lookup attribute from the field rule, if specified. The lookup field refers to a field on the object associated with the field rule's target_object_field, and is intended to be passed into a RecordService call.
      Returns:
      the name of the target field lookup to obtain data from, or null if not specified

    • isActive

      boolean isActive()
      Determines whether this rule is active. Rules are active (true) by default.
      Returns:
      status of the rule, true if active or false if inactive

    • getQueryObject

      String getQueryObject()
      Retrieves the name of the mapped query object. Must be specified as returned in VQL response. For example, if the mapped query object is a Vault object, this returns the object name such as product__v. If the mapped object is a document, returns Document.
      Returns:
      name of mapped query object

    • getQueryField

      String getQueryField()
      Retrieves the name of the mapped query field. If only query_field and query_object are specified, the target field value is set to this query object's query field value. For example, name__v or doc_number__v.

      You can retrieve a list of query fields with IntegrationRule.getQueryFields(String).

      Returns:
      name of mapped query field, or null if no query field mapping exists

    • getFieldDefault

      String getFieldDefault()
      The static default value. If specified alone, the target field value will be set to this static value. If specified with query_field, then this static value is used when the query field is null or not available.
      Returns:
      static default for the field

    • getReferenceLookupType

      ReferenceLookupType getReferenceLookupType()
      The ReferenceLookupType of the fieldrule. May be null.
      Returns:
      ReferenceLookupType enum

    • getReferenceLookup

      String getReferenceLookup()
      The name of the reference lookup object. Value specifies the object context for the lookup, requires query_field which is used as the lookup key. When used, the target field value will be set based on a reference lookup from the "Reference Lookup" vof object (reference_lookup__sys). May be null.
      Returns:
      name of the object context for the lookup

    • getQueryFieldType

      <T extends FieldType> T getQueryFieldType(Class<T> queryObjectType)
      Retrieves the FieldType of the mapped query object type ObjectFieldType or DocumentFieldType. This returns null if there is no enum value in the MDL.
      Type Parameters:
      T - the FieldType class - either ObjectFieldType or DocumentFieldType
      Parameters:
      queryObjectType - the ObjectFieldType or DocumentFieldType class
      Returns:
      FieldType - either ObjectFieldType or DocumentFieldType enum

    • getQueryFieldSelect

      String getQueryFieldSelect()
      Retrieves the "Query Field Select" attribute from the field rule, if added. Field will be used in the SDK Integration Rule Query Builder in order to use as the select clause for a remote query
      Returns:
      String input to use as override for select clause