Package org.osid.hold

package org.osid.hold

The Open Service Interface Definitions for the org.osid.hold service.

The Hold OSID provides a means for manging blacklists. The Hold OSID adds the concept of "except for" to the OSID environment. The Hold OSID can be used as part of the implementation of an Authorization OSID to override authorization Functions or as part of the Rules OSID to define managed Checks in a business process.

Issues

An Issue represents a problem. A problem might be the lack of a payment or the hosing of a system.

Holds

A Hold is an OsidRelationship between a Resource and an Issue. A Hold says that a person has not made their payment or has some problem identified by the related Issue .

Blocks

Issues are be mapped to Blocks . The Block is the entity that is checked by an external evaluator. A person is "blocked" if they have any Holds related to Issues mapped to the Block. The separation of a Block and an Issue allows for one party to maintain their set of Issues that impacts the business process of another party that authors the Blocks . An example is a registrar of a university that blocks registration for students who have not returned their library books.

Oubliette Cataloging

Holds , Issues , and Blocks are organized into federatable OsidCatalogs called Oubliettes .

Sub Packages

The Hold OSID contains a Hold Rules OSID for managing the rules behind Issues and Holds and a Hold Batch OSID for managing Holds and Issues in bulk.

Copyright © 2010 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.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.hold.batch	The Open Service Interface Definitions for the org.osid.hold.batch service.
org.osid.hold.records
org.osid.hold.rules	The Open Service Interface Definitions for the org.osid.hold.rules service.

Interfaces

Class	Description
Block	A Block .
BlockAdminSession	This session creates, updates, and deletes Blocks .
BlockForm	This is the form for creating and updating Blocks .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BlockAdminSession .
BlockList	Like all OsidLists , BlockList provides a means for accessing Block elements sequentially either one at a time or many at a time.
BlockLookupSession	This session provides methods for retrieving Block objects.
BlockNotificationSession	This session defines methods to receive notifications on adds/changes to Block objects in this Oubliette .
BlockOublietteAssignmentSession	This session provides methods to re-assign Blocks to Oubliette mappings.
BlockOublietteSession	This session provides methods to retrieve Block to Oubliette holds.
BlockQuery	This is the query for searching blocks.
BlockQueryInspector	This is the query inspector for examining block queries.
BlockQuerySession	This session provides methods for searching among Block objects.
BlockReceiver	The block receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Block objects.
BlockSearch	The search interface for governing block searches.
BlockSearchOrder	An interface for specifying the ordering of search results.
BlockSearchResults	This interface provides a means to capture results of a search.
BlockSearchSession	This session provides methods for searching among Block objects.
BlockSession	This is the basic session for checking blocks.
BlockSmartOublietteSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Hold	A Hold is an Issue applicable to a Resource or Agent .
HoldAdminSession	This session creates, updates, and deletes Holds .
HoldForm	This is the form for creating and updating Holds .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the HoldAdminSession .
HoldList	Like all OsidLists , HoldList provides a means for accessing Hold elements sequentially either one at a time or many at a time.
HoldLookupSession	This session provides methods for retrieving Hold relationships.
HoldManager	The hold manager provides access to rules sessions and provides interoperability tests for various aspects of this service.
HoldNotificationSession	This session defines methods to receive notifications on adds/changes to Hold objects in this Oubliette .
HoldOublietteAssignmentSession	This session provides methods to re-assign Holds to Oubliette mappings.
HoldOublietteSession	This session provides methods to retrieve Hold to Oubliette mappings.
HoldProfile	The hold profile describes the interoperability among hold services.
HoldProxyManager	The hold proxy manager provides access to rules sessions and provides interoperability tests for various aspects of this service.
HoldQuery	This is the query for searching holds.
HoldQueryInspector	This is the query inspector for examining hold queries.
HoldQuerySession	This session provides methods for searching among Hold objects.
HoldReceiver	The hold receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Hold objects.
HoldSearch	The search interface for governing hold searches.
HoldSearchOrder	An interface for specifying the ordering of search results.
HoldSearchResults	This interface provides a means to capture results of a search.
HoldSearchSession	This session provides methods for searching among Hold objects.
HoldSmartOublietteSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Issue	A Issue represents a problem.
IssueAdminSession	This session creates, updates, and deletes Ieeues .
IssueForm	This is the form for creating and updating Issues .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the IssueAdminSession .
IssueList	Like all OsidLists , IssueList provides a means for accessing Issue elements sequentially either one at a time or many at a time.
IssueLookupSession	This session defines methods for retrieving issues.
IssueNotificationSession	This session defines methods to receive notifications on adds/changes to Issue objects in this Oubliette .
IssueOublietteAssignmentSession	This session provides methods to re-assign Issues to Oubliette mappings.
IssueOublietteSession	This session provides methods to retrieve Issue to Oubliette issues.
IssueQuery	This is the query for searching issues.
IssueQueryInspector	This is the query inspector for examining issue queries.
IssueQuerySession	This session provides methods for searching among Issue objects.
IssueReceiver	The issue receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted issues.
IssueSearch	The search interface for governing issue searches.
IssueSearchOrder	An interface for specifying the ordering of search results.
IssueSearchResults	This interface provides a means to capture results of a search.
IssueSearchSession	This session provides methods for searching among Issue objects.
IssueSmartOublietteSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
MyHoldSession	This session defines methods for retrieving holds pertaining to the authenticated agent.
Oubliette	An Oubliette represents a collection of blocks.
OublietteAdminSession	This session creates, updates, and deletes Oubliettes .
OublietteForm	This is the form for creating and updating oubliettes.
OublietteHierarchyDesignSession	This session defines methods for managing a hierarchy of Oubliette objects.
OublietteHierarchySession	This session defines methods for traversing a hierarchy of Oubliette objects.
OublietteList	Like all OsidLists , OublietteList provides a means for accessing Oubliette elements sequentially either one at a time or many at a time.
OublietteLookupSession	This session provides methods for retrieving Oubliette objects.
OublietteNode	This interface is a container for a partial hierarchy retrieval.
OublietteNodeList	Like all OsidLists , OublietteNodeList provides a means for accessing OublietteNode elements sequentially either one at a time or many at a time.
OublietteNotificationSession	This session defines methods to receive notifications on adds/changes to Oubliette objects.
OublietteQuery	This is the query for searching oubliettes.
OublietteQueryInspector	This is the query inspector for examining oubliette queries.
OublietteQuerySession	This session provides methods for searching among Oubliette objects.
OublietteReceiver	The oubliette receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Oubliette objects.
OublietteSearch	The search interface for governing oubliette searches.
OublietteSearchOrder	An interface for specifying the ordering of search results.
OublietteSearchResults	This interface provides a means to capture results of a search.
OublietteSearchSession	This session provides methods for searching among Oubliette objects.