org.osid.relationship

Interface Summary
Interface	Description
Family	A `Family` represents a collection of relationships.
FamilyAdminSession	This session creates, updates, and deletes `Families.`
FamilyForm	This is the form for creating and updating `Family` objects.
FamilyHierarchyDesignSession	This session manages a hierarchy of families may be organized into a hierarchy for organizing or federating.
FamilyHierarchySession	This session defines methods for traversing a hierarchy of `Family` objects.
FamilyList	Like all `OsidLists,` `FamilyList` provides a means for accessing `Family` elements sequentially either one at a time or many at a time.
FamilyLookupSession	This session provides methods for retrieving `Family` objects.
FamilyNode	This interface is a container for a partial hierarchy retrieval.
FamilyNodeList	Like all `OsidLists,` `FamilyNodeList` provides a means for accessing `FamilyNode` elements sequentially either one at a time or many at a time.
FamilyNotificationSession	This session defines methods to receive notifications on adds/changes to `Family` objects.
FamilyQuery	This is the query interface for searching for families.
FamilyQueryInspector	This is the query inspector for examining family queries.
FamilyQuerySession	This session provides methods for searching `Family` objects.
FamilyReceiver	The family receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Family` objects.
FamilySearch	The search interface for governing family searches.
FamilySearchOrder	An interface for specifying the ordering of search results.
FamilySearchResults	This interface provides a means to capture results of a search and is used as a vehicle to perform a search within a previous result set.
FamilySearchSession	This session provides methods for searching `Family` objects.
Relationship	A `Relationship` is an object between two peers.
RelationshipAdminSession	This session creates, updates, and deletes `Relationships.`
RelationshipFamilyAssignmentSession	This session provides methods to re-assign `Relationships` to `Family` objects A `Relationship` may appear in multiple `Family` objects and removing the last reference to a `Relationship` is the equivalent of deleting it.
RelationshipFamilySession	This session provides methods to retrieve `Relationship` to `Family` mappings.
RelationshipForm	This is the form for creating and updating `Relationships.`
RelationshipList	Like all `OsidLists,` `Relationship` provides a means for accessing `Relationship` elements sequentially either one at a time or many at a time.
RelationshipLookupSession	This session defines methods for retrieving relationships.
RelationshipManager	The relationship manager provides access to relationship sessions and provides interoperability tests for various aspects of this service.
RelationshipNotificationSession	This session defines methods to receive notifications on adds/changes to `Relationship` objects in this `Family.`
RelationshipProfile	The relationship profile describes the interoperability among relationship services.
RelationshipProxyManager	The relationship manager provides access to relationship sessions and provides interoperability tests for various aspects of this service.
RelationshipQuery	This is the query for searching relationships.
RelationshipQueryInspector	This is the query inspector for examining relationship queries.
RelationshipQuerySession	This session provides methods for searching among `Relationship` objects.
RelationshipReceiver	The relationship receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Relationship` objects.
RelationshipSearch	The search interface for governing relationship searches.
RelationshipSearchOrder	An interface for specifying the ordering of search results.
RelationshipSearchResults	This interface provides a means to capture results of a search.
RelationshipSearchSession	This session provides methods for searching among `Relationship` objects.
RelationshipSmartFamilySession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Package org.osid.relationship Description

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

The Relationship OSID provides the ability to relate and manage data between OsidObjects.

Relationships

The Relationship OSID defines a Relationship that can be used to explicitly identify a relationship between two OSID Ids and manage information specific to the relationship.

The Relationship OSID is a building block on which relationships defined in the context of other OSIDs can be built. Examples of relationships include the enrollment record of a student in a Course or the commitment or a person to an Event.

The Relationship OSID depends on the relationship Type to indicate the nature of the relationship including its natural ordering between the source and destination Ids. A relationship of type "friend" may place the peers in either order and be queryable in either order. A relationship of type "parent" is between a father peer and a son peer, but not the other way around. Queries of the son peer based on the "parent" type is not equiavelent to queries of the father peer based on the "parent" type.

Such directional relationships may be accompanied by two types. An additional relationship type of "child" can be used with the son peer to determine the father peer. The directionality and the inverse among the types are part of the type definition.

Family Cataloging

Relationships may be cataloged using the Family interface.

Sub Packages

The Relationship OSID includes a Relationship Rules OSID for controlling the enable status of Relationships.

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.