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

Interface IntegrationRule

public interface IntegrationRule
Provides methods to retrieve information related to an IntegrationRule. Contract object for the Integrationrule component.

  • Method Details

    • getName

      String getName()
      Retrieves this IntegrationRule name. For example, my_integration_rule__c. This value is never null.
      Returns:
      rule name

    • getLabel

      String getLabel()
      Retrieves this IntegrationRule label. For example, My Integration Rule. This value may be null.
      Returns:
      rule label

    • isActive

      boolean isActive()
      Retrieves the activation status of this rule. Integration rules are active (true) by default.
      Returns:
      status of the rule

    • getConnection

      String getConnection()
      Retrieves the API name (api_name__sys) of the Connection record referenced by this rule.
      Returns:
      API name of the connection record

    • getIntegrationPoint

      String getIntegrationPoint()
      Retrieves the API name (integration_point_api_name__sys) of the Integration Point record referenced by this rule. This value may be null.
      Returns:
      API name of the integration point record

    • getPrimaryQueryObject

      String getPrimaryQueryObject()
      Retrieves the name of the primary query object of this integration rule. For example, product__v.
      Returns:
      name of primary query object, or null if no primary query object is set on this integration rule

    • getFieldRules

      Collection<FieldRule> getFieldRules()
      Retrieves the list of the Fieldrules sub-component under this Integrationrule component. May return an empty Collection if no matches are found.
      Returns:
      a Collection of FieldRule objects

    • getQueryObjectRules

      Collection<QueryObjectRule> getQueryObjectRules()
      Retrieves all of the Queryobjectrules for the Integrationrule
      Returns:
      Collection of Queryobjectrules

    • getQueryObjectRules

      Collection<QueryObjectRule> getQueryObjectRules(String sourceObject)
      Retrieves any Queryobjectrules which have the specified value for their object field.
      Parameters:
      sourceObject - object value on the Queryobjectrule. Cannot be null.
      Returns:
      Collection of Queryobjectrules

    • getQueryFields

      Collection<String> getQueryFields(String queryObjectName)
      Retrieves a Collection of query fields referenced in Fieldrules for the specified query object. May return an empty Collection if no matches are found.
      Parameters:
      queryObjectName - name of query object
      Returns:
      a Collection of query fields