RuleService

Name Rule
Version
Included Services  
Java Package org.kuali.rice.kew.api.rule

Copyright 2005-2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.opensource.org/licenses/ecl2.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Operations
Main Message Structures

Method getRule
Description gets a Rule identified by the passed in id
Parameters String id unique id for the Rule
Return Rule Rule with the passed in unique id
Errors RiceIllegalArgumentException ???
RiceIllegalStateException ???

Back to Operations

Method getRuleByName
Description gets a Rule identified by the passed in rule name
Parameters String name name of the Rule
Return Rule Rule with the passed in unique id
Errors RiceIllegalArgumentException ???
RiceIllegalStateException ???

Back to Operations

Method getRulesByTemplateId
Description gets a list of Rules with the specified templateId
Parameters String templateId unique id for the Rule
Return RuleList Rules with the passed in templateId, or an empty list if none exist
Errors RiceIllegalArgumentException ???

Back to Operations

Method getRulesByTemplateNameAndDocumentTypeName
Description Gets a list of Rules with the specified templateId and documentTypeName. Scales up the hierarchy of
documentTypes
Parameters String templateName unique name for the Rule Template. Cannot be null or empty
String documentTypeName documentTypeName for Rule. Cannot be null or empty
Return RuleList Rules with the passed in templateId, documentTypeName (or parent document type)or an empty list if none exist
Errors RiceIllegalArgumentException ???

Back to Operations

Method getRulesByTemplateNameAndDocumentTypeNameAndEffectiveDate
Description Gets a list of Rules with the specified templateId and documentTypeName. Scales up the hierarchy of
documentTypes
Parameters String templateName unique name for the Rule Template. Cannot be null or empty
String documentTypeName documentTypeName for Rule. Cannot be null or empty
DateTime effectiveDate date for rule effectiveness. Can be null. If null, current time is used.
Return RuleList Rules with the passed in templateId, documentTypeName (or parent document type)or an empty list if none exist
Errors RiceIllegalArgumentException ???

Back to Operations

Method findRules
Description Query for rules based on the given search criteria which is a Map of rule field names to values.


This method returns it's results as a List of Rules that match the given search criteria.
Parameters QueryByCriteria queryByCriteria the criteria. Cannot be null.
Return RuleQueryResults a list of Rule objects in which the given criteria match Rule properties. An empty list is returned if an invalid or
non-existent criteria is supplied.
Errors RiceIllegalArgumentException ???

Back to Operations

Method ruleReport
Description Executes a simulation of a document to get all previous and future route information
Parameters RuleReportCriteria reportCriteria criteria for the rule report to follow
Return RuleList list of Rules representing the results of the rule report
Errors RiceIllegalArgumentException ???

Back to Operations

Method getRuleTemplate
Description gets a RuleTemplate identified by the passed in id
Parameters String id unique id for the RuleTemplate
Return RuleTemplate RuleTemplate with the passed in unique id
Errors RiceIllegalArgumentException ???

Back to Operations

Method getRuleTemplateByName
Description gets a RuleTemplate identified by the passed in name
Parameters String name unique name for the RuleTemplate
Return RuleTemplate RuleTemplate with the passed in unique name
Errors RiceIllegalArgumentException ???

Back to Operations

Method findRuleTemplates
Description Query for rules based on the given search criteria which is a Map of ruleTemplate field names to values.


This method returns it's results as a List of RuleTemplates that match the given search criteria.
Parameters QueryByCriteria queryByCriteria the criteria. Cannot be null.
Return RuleTemplateQueryResults a list of RuleTemplate objects in which the given criteria match RuleTemplate properties.
An empty list is returned if an invalid or non-existent criteria is supplied.
Errors RiceIllegalArgumentException ???

Back to Operations

Method getRuleResponsibility
Description gets a RuleResponsibility identified by the passed in responsibilityId
Parameters String responsibilityId unique id for the RuleResponsibility
Return RuleResponsibility RuleResponsibility with the passed in unique responsibilityId
Errors RiceIllegalArgumentException ???

Back to Operations

Method getRuleDelegationsByResponsibiltityId
Description gets a RuleDelegations identified by the passed in id for responsibility
Parameters String id unique id for the RuleDelegation's Responsibility
Return RuleDelegationList List of RuleDelegations with the provided ReponsibilityId. Returns an empty list if none exist.
Errors RiceIllegalArgumentException ???

Back to Operations