org.osid.ontology

Interface Summary
Interface	Description
Ontology	An ontology defines a collection of subjects.
OntologyAdminSession	This session creates, updates, and deletes `Ontologies.`
OntologyAssignmentSession	This session provides methods to manage `Id` to `Ontology` mappings.
OntologyForm	This is the form for creating and updating ontologies.
OntologyHierarchyDesignSession	This session defines methods for managing a hierarchy of `Ontology` objects.
OntologyHierarchySession	This session defines methods for traversing a hierarchy of `Ontology` objects.
OntologyList	Like all `OsidLists,` `OntologyList` provides a means for accessing `Ontology` elements sequentially either one at a time or many at a time.
OntologyLookupSession	This session provides methods for retrieving `Ontology` objects.
OntologyManager	The ontology manager provides access to ontology sessions and provides interoperability tests for various aspects of this service.
OntologyNode	This interface is a container for a partial hierarchy retrieval.
OntologyNodeList	Like all `OsidLists,` `OntologyNodeList` provides a means for accessing `OntologyNode` elements sequentially either one at a time or many at a time.
OntologyNotificationSession	This session defines methods to receive notifications on adds/changes to `Ontology` objects.
OntologyProfile	The `OntologyProfile` describes the interoperability among ontology services.
OntologyProxyManager	The authentication manager provides access to ontology sessions and provides interoperability tests for various aspects of this service.
OntologyQuery	This is the query for searching ontologies.
OntologyQueryInspector	This is the query inspector for examining ontology queries.
OntologyQuerySession	This session provides methods for searching among `Ontology` objects.
OntologyReceiver	The vault receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Ontology` objects.
OntologySearch	The interface for governing ontology searches.
OntologySearchOrder	An interface for specifying the ordering of search results.
OntologySearchResults	This interface provides a means to capture results of a search.
OntologySearchSession	This session provides methods for searching among `Ontology` objects.
Relevancy	A `Relevancy` maps an `Id` to an `Subject.`
RelevancyAdminSession	This session creates, updates, and deletes `Relevancies.`
RelevancyForm	This is the form for creating and updating `Relevancy` objects.
RelevancyList	Like all `OsidLists,` `RelevancyList` provides a means for accessing `Relevancy` elements sequentially either one at a time or many at a time.
RelevancyLookupSession	This session provides methods for examining subject relevancy.
RelevancyNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to subject relevancies.
RelevancyOntologyAssignmentSession	This session provides methods to re-assign `Relevancies` to `Ontologies.`
RelevancyOntologySession	This session provides methods to retrieve `Relevancy` to `Ontology` mappings.
RelevancyQuery	This is the query for searching relevancies.
RelevancyQueryInspector	This is the query inspector for examining relevancy queries.
RelevancyQuerySession	This session provides methods for searching `Relevancy` objects.
RelevancyReceiver	This receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted relevancies.
RelevancySearch	`RelevancySearch` defines the interface for specifying relevancy search options.
RelevancySearchOrder	An interface for specifying the ordering of search results.
RelevancySearchResults	This interface provides a means to capture results of a search.
RelevancySearchSession	This session provides methods for searching `Relevancy` objects.
RelevancySmartOntologySession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Subject	A `Subject` represents a span of time and an optional location.
SubjectAdminSession	This session creates, updates, and deletes `Subjects.`
SubjectForm	This is the form for creating and updating `Subjects.`
SubjectHierarchyDesignSession	This session defines methods for managing a hierarchy of `Subject` objects.
SubjectHierarchySession	This session defines methods for traversing a hierarchy of `Subject` objects.
SubjectList	Like all `OsidLists,` `SubjectList` provides a means for accessing `Subject` elements sequentially either one at a time or many at a time.
SubjectLookupSession	This session provides methods for retrieving `Subject` s.
SubjectNode	This interface is a container for a partial hierarchy retrieval.
SubjectNodeList	Like all `OsidLists,` `SubjectNodeList` provides a means for accessing `SubjectNode` elements sequentially either one at a time or many at a time.
SubjectNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `Subject` objects.
SubjectOntologyAssignmentSession	This session provides methods to re-assign `Subjects` to `Ontologies.`
SubjectOntologySession	This session provides methods to retrieve `Subject` to `Ontology` mappings.
SubjectQuery	This is the query for searching subjects.
SubjectQueryInspector	This is the query inspector for examining subject queries.
SubjectQuerySession	This session provides methods for searching `Subject` objects.
SubjectReceiver	The subject receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Subjects.`
SubjectSearch	`SubjectSearch` defines the interface for specifying subject search options.
SubjectSearchOrder	An interface for specifying the ordering of search results.
SubjectSearchResults	This interface provides a means to capture results of a search.
SubjectSearchSession	This session provides methods for searching `Subject` objects.
SubjectSmartOntologySession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Package org.osid.ontology Description

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

The Ontology OSID is an auxiliary service used to define subject matter that can be related to OsidObjects. Ontologies are an alternative to tagging where structure, restricted vocabulary, or localization of topic names are desired.

Subjects

Subjects are used to represent a topic and can be organized in a hierarchy to form an ontology.

Relevancies

Subjects are related to OSID Ids with a Relevancy. A Relevancy is an OsidRelationship.

Ontology Cataloging

Subjects and Relevancies are organized into Ontology catalogs.

An external Id may be mapped to an Ontology. This mapping allows OsidCatalogs to relate to a specific and sharable Ontology to constrain a set of Subjects that may be relevant to a collection of external OsidObjects.

Sub Packages

The Ontology OSID includes a rules subpackage for managing rules to enable subject relevancies and an Ontology Batch OSID for managing Subjects, Relevancies, and Ontologies in bulk.

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.