Package org.osid.hierarchy

package org.osid.hierarchy

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

The Hierarchy OSID is an auxiliary service providing a means for accessing and managing hierarchical relationships among OSID Ids .

An OSID Id may have onr or more parents or children and the hierarchy itself represents a directed acyclic graph. The hierarchy service defines a set of interfaces used among other OSIDs that utilize hierarchies and can also be used to abstract hierarchical data into a standalone service.

Hierarchical queries may be performed using the HierarchyTraversalSession . A set of methods exist to query parents, children, ancestors, and decendants. A Node structure may be retrieved to access a portion of a hierarchy in bulk. The Node provides methods to get parents and children of the node directly.

Hierarchies are federateable by combining nodes. There is no hierarchy service for the hierarchy catalog.



Copyright © 2002,2008 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
    Hierarchy
    A Hierarchy represents an authenticatable identity.
    HierarchyAdminSession
    This session creates, updates, and deletes Hierarchies .
    HierarchyDesignSession
    This session provides methods to manage a hierarchy.
    HierarchyForm
    This is the form for creating and updating Hierarchies .
    HierarchyList
    Like all OsidLists , HierarchyList provides a means for accessing Id elements sequentially either one at a time or many at a time.
    HierarchyLookupSession
    This session provides methods for retrieving Hierarchies .
    HierarchyManager
    The hierarchy manager provides access sessions to traverse and manage hierrachies of Ids .
    HierarchyNotificationSession
    This session defines methods to receive notifications on adds/changes to Hierarchies .
    HierarchyProfile
    The hierarchy profile describes the interoperability among hierarchy services.
    HierarchyProxyManager
    The hierarchy manager provides access sessions to traverse and manage hierrachies of Ids .
    HierarchyQuery
    This is the query for searching hierarchies.
    HierarchyQueryInspector
    This is the query inspector for examining hierarchy queries.
    HierarchyQuerySession
    This session provides methods for searching among Hierarchies .
    HierarchyReceiver
    The hierarchy receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Hierarchy objects.
    HierarchySearch
    HierarchySearch defines the interface for specifying hierarchy search options.
    HierarchySearchOrder
    An interface for specifying the ordering of search results.
    HierarchySearchResults
    This interface provides a means to capture results of a search.
    HierarchySearchSession
    This session provides methods for searching among Hierarchies .
    HierarchySequencingSession
    This session provides methods to sequence the nodes in a hierarchy.
    HierarchyStructureNotificationSession
    This session defines methods to receive notifications on adds/changes to a hierarchical structure.
    HierarchyStructureReceiver
    The hierarchy receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted hierarchy nodes.
    HierarchyTraversalSession
    This session defines methods for traversing a hierarchy.
    Node
    This interface is a container for a partial hierarchy retrieval.
    NodeList
    Like all OsidLists , NodeList provides a means for accessing Id elements sequentially either one at a time or many at a time.