Package org.osid.cataloging

package org.osid.cataloging

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

The Cataloging OSID is an auxiliary service and provides a means for organizing OsidObjects into OsidCatalogs . An OsidObject is represented by an OSID Id .

Catalogs can be organized into hierarchies for federation. A Catalog that is a parent of another catalog includes the Ids of its children.

The Cataloging OSID provides the core definition for the cataloging functions used throughout the OSIDs and aids in the adaptability of cataloging structures.

Sub Packages

The Cataloging OSID includes a rules package for managing the behavior of a Catalog in a federated hierarchy.



Copyright © 2006-2007 Massachusetts Institute of Technology.

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 nodify 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.

  • Interfaces
    Class
    Description
    Catalog
    A Catalog represents a collection of entries.
    CatalogAdminSession
    This session creates, updates, and deletes Catalogs .
    CatalogAssignmentSession
    This session provides methods to assign OSID Ids to Catalogs .
    CatalogEntryNotificationSession
    This session defines methods to receive notifications on adds/changes to a catalog assignment.
    CatalogEntryReceiver
    The catalog receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Ids in Catalogs .
    CatalogForm
    This is the form for creating and updating Catalogs .
    CatalogHierarchyDesignSession
    This session manages a hierarchy of catalogs.
    CatalogHierarchySession
    This session defines methods for traversing a hierarchy of Catalogs .
    CatalogingManager
    The cataloging manager provides access to cataloging sessions and provides interoperability tests for various aspects of this service.
    CatalogingProfile
    The cataloging profile describes the interoperability among cataloging services.
    CatalogingProxyManager
    The cataloging manager provides access to cataloging sessions and provides interoperability tests for various aspects of this service.
    CatalogList
    Like all OsidLists , CatalogList provides a means for accessing Catalog elements sequentially either one at a time or many at a time.
    CatalogLookupSession
    This session provides methods for retrieving Catalogs .
    CatalogNode
    This interface is a container for a partial hierarchy retrieval.
    CatalogNodeList
    Like all OsidLists , CatalogNodeList provides a means for accessing CatalogNode elements sequentially either one at a time or many at a time.
    CatalogNotificationSession
    This session defines methods to receive notifications on adds/changes to Catalogs .
    CatalogQuery
    This is the query for searching catalogs.
    CatalogQueryInspector
    This is the query inspector for examining catalog queries.
    CatalogQuerySession
    This session provides methods for searching Catalogs .
    CatalogReceiver
    The catalog receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Catalog objects.
    CatalogSearch
    The search interface for governing the search query for Catalogs .
    CatalogSearchOrder
    An interface for specifying the ordering of search results.
    CatalogSearchResults
    This interface provides a means to capture results of a search.
    CatalogSearchSession
    This session provides methods for searching Catalogs .
    CatalogSession
    This session provides methods to retrieve Id to Catalog mappings.