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

Interface IntegrationRuleService

All Superinterfaces:
Service
public interface IntegrationRuleService extends Service
Provides methods to retrieve and evaluate integration rules.

  • Method Details

    • getIntegrationRules

      @Deprecated Collection<IntegrationRule> getIntegrationRules(String connectionId)
      Deprecated.
      as of 19R3.2, replaced by getIntegrationRules(GetIntegrationRulesRequest)
      Retrieves the list of IntegrationRules corresponding to a Connection given a connection ID.

      If there are no rules corresponding to the connection ID, this returns an empty collection. If the connection ID does not exist or is inactive, this throws an exception.

      Parameters:
      connectionId - connection ID
      Returns:
      a Collection of IntegrationRule contract objects

    • evaluateFieldRules

      @Deprecated Collection<FieldRuleResult> evaluateFieldRules(IntegrationRule integrationRule, String targetName, JsonObject queryDescribe, JsonObject data)
      Deprecated.
      as of 19R3.2, replaced by evaluateFieldRules(EvaluateFieldRulesRequest)
      Evaluates all field rules under the IntegrationRule object with the given name.

      For each field rule, returns the resulting value for a field based on the evaluation of the rule against a json query response record.

      Throws an error if the target is not found in the query response.

      Parameters:
      integrationRule - corresponding integrationRule component
      targetName - name of target field
      queryDescribe - the metadata for the query
      data - json query response record
      Returns:
      a Collection of FieldRuleResults which contain the resulting value of the for the target based on the evaluation of the integration rule

    • getIntegrationRulesByIntegrationPoint

      @Deprecated Collection<IntegrationRule> getIntegrationRulesByIntegrationPoint(String connectionId, String integrationPointAPIName)
      Deprecated.
      as of 19R3.2, replaced by getIntegrationRules(GetIntegrationRulesRequest)
      For internal Veeva use only. Retrieves the list of IntegrationRules corresponding to a Connection given a connection ID and an integration point API name.

      If there are no rules corresponding to the connection ID and integration point API name, this returns an empty collection. If the connection ID does not exist or is inactive, this throws an exception. If the integration point API name does not exist, this throws an exception.

      Parameters:
      connectionId - connection ID
      integrationPointAPIName - integration point API name
      Returns:
      a Collection of IntegrationRule contract objects

    • newGetIntegrationRulesRequestBuilder

      GetIntegrationRulesRequestBuilder newGetIntegrationRulesRequestBuilder()
      Begin a request to get integration rules. This method builds a GetIntegrationRulesRequestBuilder object.
      Returns:
      GetIntegrationRulesRequestBuilder contract object.

    • getIntegrationRules

      GetIntegrationRulesResponse getIntegrationRules(GetIntegrationRulesRequest getIntegrationRulesRequest)
      Retrieves the list of IntegrationRules corresponding to a Connection based on the GetIntegrationRulesRequest.

      If there are no rules corresponding to the connection ID, this returns an empty Collection. If the connection ID does not exist or is inactive, this throws an exception.

      Parameters:
      getIntegrationRulesRequest - the GetIntegrationRulesRequest to retrieve the integration rules from
      Returns:
      GetIntegrationRulesResponse object which contains the list of IntegrationRules

    • newEvaluateFieldRulesRequestBuilder

      EvaluateFieldRulesRequestBuilder newEvaluateFieldRulesRequestBuilder()
      Begin a request to evaluate field rule. This method builds an EvaluateFieldRulesRequestBuilder object.
      Returns:
      EvaluateFieldRulesRequestBuilder contract object

    • evaluateFieldRules

      EvaluateFieldRulesResponse evaluateFieldRules(EvaluateFieldRulesRequest evaluateFieldRulesRequest)
      Evaluates a constructed EvaluateFieldRulesRequest.

      Evaluates all field rules under the IntegrationRule object with the given name. For each field rule, returns the resulting value for a field based on the evaluation of the rule against a JSON query response record.

      If an error occurs when evaluating a field rule, the error type and message are placed in the FieldRuleResult.

      Parameters:
      evaluateFieldRulesRequest - the EvaluateFieldRulesRequest object to evaluate
      Returns:
      an EvaluateFieldRulesResponse object which contains data about the evaluation

    • newIntegrationRuleQueryBuilder

      IntegrationRuleQuery.Builder newIntegrationRuleQueryBuilder()
      Creates an IntegrationRuleQuery.Builder.
      Returns:
      an IntegrationRuleQuery.Builder