org.kuali.rice.kew.rule.service
Interface RuleService

All Superinterfaces:

XmlExporter, XmlLoader

All Known Implementing Classes:

RuleServiceImpl

public interface RuleService
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:

RuleBaseValues, RuleResponsibility

Method Summary

void	delete(String ruleBaseValuesId)
void	deleteRuleResponsibilityById(String ruleResponsibilityId)
List	fetchAllCurrentRulesForTemplateDocCombination(String ruleTemplateName, String documentType)
List	fetchAllCurrentRulesForTemplateDocCombination(String ruleTemplateName, String documentType, Timestamp effectiveDate)
List	fetchAllRules(boolean currentRules)
List<RuleBaseValues>	findByDocumentId(String documentId)
RuleResponsibility	findByRuleResponsibilityId(String ruleResponsibilityId)
RuleBaseValues	findDefaultRuleByRuleTemplateId(String ruleTemplateId)
String	findResponsibilityIdForRule(String ruleName, String ruleResponsibilityName, String ruleResponsibilityType)
RuleBaseValues	findRuleBaseValuesById(String ruleBaseValuesId)
List	findRuleBaseValuesByResponsibilityReviewer(String reviewerName, String type)
List	findRuleBaseValuesByResponsibilityReviewerTemplateDoc(String ruleTemplateName, String documentType, String reviewerName, String type)
RuleResponsibility	findRuleResponsibility(String responsibilityId)
String	getDuplicateRuleId(RuleBaseValues rule) Checks if the Rule with the given value is a duplicate of an existing rule in the system.
RuleBaseValues	getParentRule(String ruleBaseValuesId)
RuleBaseValues	getRuleByName(String name) Returns a Rule based on unique name.
String	getRuleDocmentTypeName(List rules) Returns the name of the document type definition that should be used to route the given List of rules.
String	isLockedForRouting(String currentRuleBaseValuesId)
void	makeCurrent(RuleBaseValues rule, boolean isRetroactiveUpdatePermitted)
void	makeCurrent(RuleDelegation ruleDelegation, boolean isRetroactiveUpdatePermitted)
void	makeCurrent(String documentId)
String	routeRuleWithDelegate(String documentId, RuleBaseValues parentRule, RuleBaseValues delegateRule, PrincipalContract principal, String annotation, boolean blanketApprove)
void	save2(RuleBaseValues ruleBaseValues)
RuleBaseValues	saveRule(RuleBaseValues rule, boolean isRetroactiveUpdatePermitted)
RuleDelegation	saveRuleDelegation(RuleDelegation ruleDelegation, boolean isRetroactiveUpdatePermitted)
List<RuleDelegation>	saveRuleDelegations(List<RuleDelegation> ruleDelegationsToSave, boolean isRetroactiveUpdatePermitted)
List<RuleBaseValues>	saveRules(List<RuleBaseValues> rulesToSave, boolean isRetroactiveUpdatePermitted)
List<RuleBaseValues>	search(String docTypeName, String ruleId, String ruleTemplateId, String ruleDescription, String groupId, String principalId, Boolean delegateRule, Boolean activeInd, Map extensionValues, String workflowIdDirective)
List<RuleBaseValues>	searchByTemplate(String docTypeName, String ruleTemplateName, String ruleDescription, String groupId, String principalId, Boolean workgroupMember, Boolean delegateRule, Boolean activeInd, Map extensionValues, Collection<String> actionRequestCodes)
void	validate2(RuleBaseValues ruleBaseValues, RuleDelegation ruleDelegation, List errors)

Methods inherited from interface org.kuali.rice.core.framework.impex.xml.XmlLoader

loadXml

Methods inherited from interface org.kuali.rice.core.framework.impex.xml.XmlExporter

export, supportPrettyPrint

Method Detail

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,
                             PrincipalContract principal,
                             String annotation,
                             boolean blanketApprove)
                             throws Exception

Throws:

Exception

save2

void save2(RuleBaseValues ruleBaseValues)
           throws Exception

Throws:

Exception

validate2

void validate2(RuleBaseValues ruleBaseValues,
               RuleDelegation ruleDelegation,
               List errors)
               throws Exception

Throws:

Exception

delete

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

RuleResponsibility findRuleResponsibility(String responsibilityId)

deleteRuleResponsibilityById

void deleteRuleResponsibilityById(String ruleResponsibilityId)

findByRuleResponsibilityId

RuleResponsibility findByRuleResponsibilityId(String ruleResponsibilityId)

fetchAllCurrentRulesForTemplateDocCombination

List fetchAllCurrentRulesForTemplateDocCombination(String ruleTemplateName,
                                                   String documentType)

fetchAllCurrentRulesForTemplateDocCombination

List fetchAllCurrentRulesForTemplateDocCombination(String ruleTemplateName,
                                                   String documentType,
                                                   Timestamp effectiveDate)

findByDocumentId

List<RuleBaseValues> findByDocumentId(String documentId)

makeCurrent

void makeCurrent(String documentId)

makeCurrent

void makeCurrent(RuleBaseValues rule,
                 boolean isRetroactiveUpdatePermitted)

makeCurrent

void makeCurrent(RuleDelegation ruleDelegation,
                 boolean isRetroactiveUpdatePermitted)

findRuleBaseValuesByResponsibilityReviewer

List findRuleBaseValuesByResponsibilityReviewer(String reviewerName,
                                                String type)

findRuleBaseValuesByResponsibilityReviewerTemplateDoc

List findRuleBaseValuesByResponsibilityReviewerTemplateDoc(String ruleTemplateName,
                                                           String documentType,
                                                           String reviewerName,
                                                           String type)

isLockedForRouting

String isLockedForRouting(String currentRuleBaseValuesId)

fetchAllRules

List fetchAllRules(boolean currentRules)

findDefaultRuleByRuleTemplateId

RuleBaseValues findDefaultRuleByRuleTemplateId(String ruleTemplateId)

getParentRule

RuleBaseValues getParentRule(String ruleBaseValuesId)

getRuleDocmentTypeName

String getRuleDocmentTypeName(List 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

RuleBaseValues saveRule(RuleBaseValues rule,
                        boolean isRetroactiveUpdatePermitted)

saveRules

List<RuleBaseValues> saveRules(List<RuleBaseValues> rulesToSave,
                               boolean isRetroactiveUpdatePermitted)

saveRuleDelegation

RuleDelegation saveRuleDelegation(RuleDelegation ruleDelegation,
                                  boolean isRetroactiveUpdatePermitted)

saveRuleDelegations

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

findResponsibilityIdForRule

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