Package org.kuali.rice.kew.rule.service

Interface RuleServiceInternal

All Superinterfaces:
XmlExporter, XmlLoader
All Known Implementing Classes:
RuleServiceInternalImpl
public interface RuleServiceInternal extends XmlLoader, XmlExporter
A service which provides data access and functions for the KEW Rules engine.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Method Details

    • getRuleByName

      RuleBaseValues getRuleByName(String name)
      Returns a Rule based on unique name. Returns null if name is null.
      Parameters:
      name - the rule name
      Returns:
      the Rule if found, null if not found or null name

    • routeRuleWithDelegate

      String routeRuleWithDelegate(String documentId, RuleBaseValues parentRule, RuleBaseValues delegateRule, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, String annotation, boolean blanketApprove) throws Exception
      Throws:
      Exception

    • save2

      @CacheEvict(value="http://rice.kuali.org/kew/v2_0/RuleType", allEntries=true) void save2(RuleBaseValues ruleBaseValues) throws Exception
      Throws:
      Exception

    • validate2

      void validate2(RuleBaseValues ruleBaseValues, RuleDelegationBo ruleDelegation, List errors) throws Exception
      Throws:
      Exception

    • delete

      @CacheEvict(value="http://rice.kuali.org/kew/v2_0/RuleType", allEntries=true) void delete(String ruleBaseValuesId)

    • findRuleBaseValuesById

      RuleBaseValues findRuleBaseValuesById(String ruleBaseValuesId)

    • search

      List<RuleBaseValues> search(String docTypeName, String ruleId, String ruleTemplateId, String ruleDescription, String groupId, String principalId, Boolean delegateRule, Boolean activeInd, Map extensionValues, String workflowIdDirective)

    • searchByTemplate

      List<RuleBaseValues> searchByTemplate(String docTypeName, String ruleTemplateName, String ruleDescription, String groupId, String principalId, Boolean workgroupMember, Boolean delegateRule, Boolean activeInd, Map extensionValues, Collection<String> actionRequestCodes)

    • findRuleResponsibility

      RuleResponsibilityBo findRuleResponsibility(String responsibilityId)

    • deleteRuleResponsibilityById

      void deleteRuleResponsibilityById(String ruleResponsibilityId)

    • findByRuleResponsibilityId

      RuleResponsibilityBo findByRuleResponsibilityId(String ruleResponsibilityId)

    • fetchAllCurrentRulesForTemplateDocCombination

      List<RuleBaseValues> fetchAllCurrentRulesForTemplateDocCombination(String ruleTemplateName, String documentType)

    • fetchAllCurrentRulesForTemplateDocCombination

      List<RuleBaseValues> fetchAllCurrentRulesForTemplateDocCombination(String ruleTemplateName, String documentType, Timestamp effectiveDate)

    • findByDocumentId

      List<RuleBaseValues> findByDocumentId(String documentId)

    • makeCurrent

      @CacheEvict(value="http://rice.kuali.org/kew/v2_0/RuleType", allEntries=true) void makeCurrent(String documentId)

    • makeCurrent

      @CacheEvict(value="http://rice.kuali.org/kew/v2_0/RuleType", allEntries=true) void makeCurrent(RuleBaseValues rule, boolean isRetroactiveUpdatePermitted)

    • makeCurrent

      @CacheEvict(value="http://rice.kuali.org/kew/v2_0/RuleType", allEntries=true) void makeCurrent(RuleDelegationBo ruleDelegation, boolean isRetroactiveUpdatePermitted)

    • findRuleBaseValuesByResponsibilityReviewer

      List<RuleBaseValues> findRuleBaseValuesByResponsibilityReviewer(String reviewerName, String type)

    • findRuleBaseValuesByResponsibilityReviewerTemplateDoc

      List<RuleBaseValues> findRuleBaseValuesByResponsibilityReviewerTemplateDoc(String ruleTemplateName, String documentType, String reviewerName, String type)

    • isLockedForRouting

      String isLockedForRouting(String currentRuleBaseValuesId)

    • fetchAllRules

      List<RuleBaseValues> fetchAllRules(boolean currentRules)

    • findDefaultRuleByRuleTemplateId

      RuleBaseValues findDefaultRuleByRuleTemplateId(String ruleTemplateId)

    • getParentRule

      RuleBaseValues getParentRule(String ruleBaseValuesId)

    • getRuleDocumentTypeName

      String getRuleDocumentTypeName(List<RuleBaseValues> rules)
      Returns the name of the document type definition that should be used to route the given List of rules. This method will never return a null value, as it will default to the default Rule document type name if not custom document type is configured for the given rules.

    • getDuplicateRuleId

      String getDuplicateRuleId(RuleBaseValues rule)
      Checks if the Rule with the given value is a duplicate of an existing rule in the system.
      Returns:
      the id of the duplicate rule if one exists, null otherwise

    • saveRule

      @CacheEvict(value="http://rice.kuali.org/kew/v2_0/RuleType", allEntries=true) RuleBaseValues saveRule(RuleBaseValues rule, boolean isRetroactiveUpdatePermitted)

    • saveRules

      @CacheEvict(value="http://rice.kuali.org/kew/v2_0/RuleType", allEntries=true) List<RuleBaseValues> saveRules(List<RuleBaseValues> rulesToSave, boolean isRetroactiveUpdatePermitted)

    • saveRuleDelegation

      RuleDelegationBo saveRuleDelegation(RuleDelegationBo ruleDelegation, boolean isRetroactiveUpdatePermitted)

    • saveRuleDelegations

      List<RuleDelegationBo> saveRuleDelegations(List<RuleDelegationBo> ruleDelegationsToSave, boolean isRetroactiveUpdatePermitted)

    • findResponsibilityIdForRule

      String findResponsibilityIdForRule(String ruleName, String ruleResponsibilityName, String ruleResponsibilityType)