## Uses of Interface
com.ibm.openpages.api.rule.ITBRuleDefinition

- Packages that use ITBRuleDefinition
  Package | Description
  --- | ---
  com.ibm.openpages.api.rule |
  com.ibm.openpages.api.service | Provides the main interfaces to work with the API services.

- - ### Uses of ITBRuleDefinition in com.ibm.openpages.api.rule

    Methods in com.ibm.openpages.api.rule that return ITBRuleDefinition
    Modifier and Type | Method and Description
    --- | ---
    `ITBRuleDefinition` | ITBRuleDefinition.`clone()` Returns a cloned instance.
    `ITBRuleDefinition` | ITBRuleFactory.`createRuleDefinition(java.lang.String name, java.lang.String objectType)` Creates a new instance of rule definition to be persisted on the system

    Methods in com.ibm.openpages.api.rule that return types with arguments of type ITBRuleDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<ITBRuleDefinition>` | TBRuleDefinitionList.`getRuleDefinitions()` Get the list of `ITBRuleDefinition` results based on the Search options provided via {#link IRuleDefinitionFindOptions}

    Constructor parameters in com.ibm.openpages.api.rule with type arguments of type ITBRuleDefinition
    Constructor and Description
    `TBRuleDefinitionList(int totalResultCount, java.util.List<ITBRuleDefinition> ruleDefinitions)`
    `TBRuleDefinitionList(java.util.List<ITBRuleDefinition> ruleDefinitions)`

  - ### Uses of ITBRuleDefinition in com.ibm.openpages.api.service

    Methods in com.ibm.openpages.api.service that return ITBRuleDefinition
    Modifier and Type | Method and Description
    --- | ---
    `ITBRuleDefinition` | ITBRuleService.`createRuleDefinition(ITBRuleDefinition ruleDefinition)` Creates a rule definition
    `ITBRuleDefinition` | ITBRuleService.`discardDraftRuleDefinition(Id ruleDefinitionId)` Discard the draft content of the rule definition.
    `ITBRuleDefinition` | ITBRuleService.`getRuleDefinition(Id ruleDefinitionId, boolean draft)` Returns a rule definition by ID
    `ITBRuleDefinition` | ITBRuleService.`getRuleDefinition(java.lang.String name, Id typeDefinitionId, boolean draft)` Returns a rule definition by name, type definition ID
    `ITBRuleDefinition` | ITBRuleService.`getRuleDefinitionByVersionId(Id versionId)` Returns the rule definition by the version ID
    `ITBRuleDefinition` | ITBRuleService.`publishRuleDefinition(Id ruleDefinitionId)` Publish the draft content of the rule definition, so it can be used during the resource creation or the user's submission.
    `ITBRuleDefinition` | ITBRuleService.`updateRuleDefinition(ITBRuleDefinition ruleDefinition)` Updates a rule definition.

    Methods in com.ibm.openpages.api.service that return types with arguments of type ITBRuleDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`evaluateRules(java.util.List<ITBRuleDefinition> rules, Id resourceId)` Evaluates a list of rules against a resource and returns the valid rules.
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRuleDefinitions()` Deprecated.
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRuleDefinitions(Id ruleDefinitionId)` Returns the published and draft versions of the rule definition if they exist.
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRuleDefinitionsByRuleType(TBRuleDefinitionType type)` Returns the latest published version of all `ITBRuleDefinitions`s by `TBRuleDefinitionType` that are currently enabled.
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRuleDefinitionsByType(Id objectType)` Returns the latest version of all `ITBRuleDefinition`s by object type
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRunnableRules(Id objectType, TBRuleDefinitionType ruleType)` Get all runnable rules for an object type

    Methods in com.ibm.openpages.api.service with parameters of type ITBRuleDefinition
    Modifier and Type | Method and Description
    --- | ---
    `ITBRuleDefinition` | ITBRuleService.`createRuleDefinition(ITBRuleDefinition ruleDefinition)` Creates a rule definition
    `ITBRuleDefinition` | ITBRuleService.`updateRuleDefinition(ITBRuleDefinition ruleDefinition)` Updates a rule definition.
    `void` | ITBRuleService.`validateRuleDefinition(ITBRuleDefinition ruleDefinition)` Validates the given rule definition and throws an `TBRuleException` when there is an issue.

    Method parameters in com.ibm.openpages.api.service with type arguments of type ITBRuleDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`evaluateRules(java.util.List<ITBRuleDefinition> rules, Id resourceId)` Evaluates a list of rules against a resource and returns the valid rules.
    `void` | ITBRuleService.`executeRules(java.util.List<ITBRuleDefinition> rules, Id resourceId)` Evaluates and executes a list of rules on a resource.

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2021. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.