Package org.osid.rules.check

The Open Service Interface Definitions for the org.osid.rules.check service.

See: Description

Interface Summary

Interface	Description
Agenda	An Agenda .
AgendaAdminSession	This session creates, updates, and deletes Agendas.
AgendaEngineAssignmentSession	This session provides methods to re-assign Agendas to Engine mappings.
AgendaEngineSession	This session provides methods to retrieve Agenda to Engine checks.
AgendaForm	This is the form for creating and updating Agendas.
AgendaList	Like all OsidLists, AgendaList provides a means for accessing Agenda elements sequentially either one at a time or many at a time.
AgendaLookupSession	This session provides methods for retrieving Agenda objects.
AgendaNotificationSession	This session defines methods to receive notifications on adds/changes to Agenda objects in this Engine.
AgendaQuery	This is the query for searching agendas.
AgendaQueryInspector	This is the query inspector for examining agenda queries.
AgendaQuerySession	This session provides methods for searching among Agenda objects.
AgendaReceiver	The agenda receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Agenda objects.
AgendaSearch	The search interface for governing agenda searches.
AgendaSearchOrder	An interface for specifying the ordering of search results.
AgendaSearchResults	This interface provides a means to capture results of a search.
AgendaSearchSession	This session provides methods for searching among Agenda objects.
AgendaSmartEngineSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Check	A Check is something that needs to checked.
CheckAdminSession	This session creates, updates, and deletes Checks.
CheckEngineAssignmentSession	This session provides methods to re-assign Checks to Engine mappings.
CheckEngineSession	This session provides methods to retrieve Check to Engine mappings.
CheckForm	This is the form for creating and updating Checks.
CheckList	Like all OsidLists, CheckList provides a means for accessing Check elements sequentially either one at a time or many at a time.
CheckLookupSession	This session provides methods for retrieving Check relationships.
CheckNotificationSession	This session defines methods to receive notifications on adds/changes to Check objects in this Engine.
CheckQuery	This is the query for searching checks.
CheckQueryInspector	This is the query inspector for examining check queries.
CheckQuerySession	This session provides methods for searching among Check objects.
CheckReceiver	The check receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Check objects.
CheckResult	The results of an evaluation.
CheckResultList	Like all OsidLists, CheckResultList provides a means for accessing CheckResult elements sequentially either one at a time or many at a time.
CheckSearch	The search interface for governing check searches.
CheckSearchOrder	An interface for specifying the ordering of search results.
CheckSearchResults	This interface provides a means to capture results of a search.
CheckSearchSession	This session provides methods for searching among Check objects.
CheckSmartEngineSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
EvaluationSession	This is the session for evaluating agendas.
Instruction	A Instruction appliies a Check to an Agenda.
InstructionAdminSession	This session creates, updates, and deletes Instructions.
InstructionEngineAssignmentSession	This session provides methods to re-assign Instructions to Engine mappings.
InstructionEngineSession	This session provides methods to retrieve Instruction to Engine instructions.
InstructionForm	This is the form for creating and updating Instructions.
InstructionList	Like all OsidLists, InstructionList provides a means for accessing Instruction elements sequentially either one at a time or many at a time.
InstructionLookupSession	This session defines methods for retrieving instructions.
InstructionNotificationSession	This session defines methods to receive notifications on adds/changes to Instruction objects in this Engine.
InstructionQuery	This is the query for searching instructions.
InstructionQueryInspector	This is the query inspector for examining instruction queries.
InstructionQuerySession	This session provides methods for searching among Instruction objects.
InstructionReceiver	The instruction receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted instructions.
InstructionSearch	The search interface for governing instruction searches.
InstructionSearchOrder	An interface for specifying the ordering of search results.
InstructionSearchResults	This interface provides a means to capture results of a search.
InstructionSearchSession	This session provides methods for searching among Instruction objects.
InstructionSmartEngineSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
ProcessingSession	This is a session for checking agendas.
RulesCheckManager	The check manager provides access to rules sessions and provides interoperability tests for various aspects of this service.
RulesCheckProfile	The rules check profile describes the interoperability among rules check services.
RulesCheckProxyManager	The check proxy manager provides access to rules sessions and provides interoperability tests for various aspects of this service.

Package org.osid.rules.check Description

The Open Service Interface Definitions for the org.osid.rules.check service.

The Rules Check OSID provides a means for managing and evaluating a series of Checks that comprise a business process. Inspired by the fine work at Kuali Student, this service manages the go/no-go business requirements that are often used within other OSID Providers.

Checks

A Check is an OsidRule that is to be evaluated. Check defines a few simple rules that can be managed directly.

• time based check using dates
• time based check using Events
• time based checks using CyclicEvents
• checks for Blocks in the Hold OSID
• checks for Audits in the Inquiry OSID
• checks for other processes

Other kinds of checks can be defined using the CheckRecord or by referencing an external Rule .

Agendas

An Agenda represents a process and has a related set of Checks to perform. OSID Consumers can simply reference an Agenda Id .

Instructions

Instructions are OsidRelationships used to relate a Check to an Agenda. Checks, once defined, can be reused among multiple Agendas. The Instruction provides the relationship along with information about how the Check is to be applied such as sequencing managed in the InstructionAdminSession, failed check messages, and processing control.

Instructions are also OsidEnablers managing the applicability of a Check. The Instruction may apply a Check at certain times, to certain Demographics of the target object , or based on a custom Rule .

Evaluation

In addition to retrieving all the Instructions for an Agenda in the InstructionLookupSession, the Rules Check OSID provides two additional services.

• ProcessingSession: Retrieves a pertinent set of Instructions filtering out those Instructions not applicable to the target Demographic or date.
• EvaluationSession: Performs the evaluation of applicable Checks in an Agenda and returns a set of statuses and messages. The eveluation accepts a Condition to supply additional data required by he Check as specified by the Check Rule.

Engine Cataloging

Checks, Instructions, and Agendas are organized into federatable OsidCatalogs called Engines.

Copyright © 2011 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.