Package org.osid.offering

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

See: Description

Interface Summary

Interface	Description
CanonicalUnit	A Canonical Unit is an approved item to be offered.
CanonicalUnitAdminSession	This session creates, updates, and deletes CanonicalUnits.
CanonicalUnitCatalogueAssignmentSession	This session provides methods to re-assign CanonicalUnits to Bilings.
CanonicalUnitCatalogueSession	This session provides methods to retrieve CanonicalUnit to Catalogue mappings.
CanonicalUnitForm	This is the form for creating and updating CanonicalUnit objects.
CanonicalUnitList	Like all OsidLists, CanonicalUnitList provides a means for accessing CanonicalUnit elements sequentially either one at a time or many at a time.
CanonicalUnitLookupSession	This session defines methods for retrieving canonical units.
CanonicalUnitNotificationSession	This session defines methods to receive notifications on adds/changes to CanonicalUnit objects.
CanonicalUnitQuery	This is the query for searching canonical units.
CanonicalUnitQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
CanonicalUnitQuerySession	This session provides methods for querying CanonicalUnit objects.
CanonicalUnitReceiver	The canonical unit receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted canonical units.
CanonicalUnitSearch	The search interface for governing canonical unit searches.
CanonicalUnitSearchOrder	An interface for specifying the ordering of search results.
CanonicalUnitSearchResults	This interface provides a means to capture results of a search.
CanonicalUnitSearchSession	This session provides methods for searching CanonicalUnit objects.
CanonicalUnitSmartCatalogueSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Catalogue	A Catalogue represents a collection of canonical units and offerings.
CatalogueAdminSession	This session creates, updates, and deletes Catalogues.
CatalogueForm	This is the form for creating and updating Catalogues.
CatalogueHierarchyDesignSession	This session manages a hierarchy of catalogues.
CatalogueHierarchySession	This session defines methods for traversing a hierarchy of Catalogue objects.
CatalogueList	Like all OsidLists, CatalogueList provides a means for accessing Catalogue elements sequentially either one at a time or many at a time.
CatalogueLookupSession	This session provides methods for retrieving Catalogue objects.
CatalogueNode	This interface is a container for a partial hierarchy retrieval.
CatalogueNodeList	Like all OsidLists, CatalogueNodeList provides a means for accessing CatalogueNode elements sequentially either one at a time or many at a time.
CatalogueNotificationSession	This session defines methods to receive notifications on adds/changes to Catalogue objects.
CatalogueQuery	This is the query for searching for catalogues.
CatalogueQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
CatalogueQuerySession	This session provides methods for querying Catalogue objects.
CatalogueReceiver	The catalogue receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Catalogue objects.
CatalogueSearch	The search interface for governing catalogue searches.
CatalogueSearchOrder	An interface for specifying the ordering of search results.
CatalogueSearchResults	This interface provides a means to capture results of a search.
CatalogueSearchSession	This session provides methods for searching Catalogue objects.
Offering	An Offering is an OsidRelationship between a CanonicalUnit and a TimePeriod.
OfferingAdminSession	This session creates, updates, and deletes Offerings.
OfferingCatalogueAssignmentSession	This session provides methods to re-assign Offerings to Bilings.
OfferingCatalogueSession	This session provides methods to retrieve Offering to Catalogue mappings.
OfferingForm	This is the form for creating and updating Offering objects.
OfferingList	Like all OsidLists, OfferingList provides a means for accessing Offering elements sequentially either one at a time or many at a time.
OfferingLookupSession	This session defines methods for retrieving offerings.
OfferingManager	The offering manager provides access to offering sessions and provides interoperability tests for various aspects of this service.
OfferingNotificationSession	This session defines methods to receive notifications on adds/changes to Offering objects.
OfferingProfile	The offering profile describes the interoperability among offering services.
OfferingProxyManager	The offering manager provides access to offering sessions and provides interoperability tests for various aspects of this service.
OfferingQuery	This is the query for searching offerings.
OfferingQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
OfferingQuerySession	This session provides methods for querying Offering objects.
OfferingReceiver	The offering receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted offerings.
OfferingSearch	The search interface for governing offering searches.
OfferingSearchOrder	An interface for specifying the ordering of search results.
OfferingSearchResults	This interface provides a means to capture results of a search.
OfferingSearchSession	This session provides methods for searching Offering objects.
OfferingSmartCatalogueSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Participant	A Participant in an OsidRelationship between an Offering and a Resource.
ParticipantAdminSession	This session creates, updates, and deletes Partiicpants.
ParticipantCatalogueAssignmentSession	This session provides methods to re-assign Participants to Bilings.
ParticipantCatalogueSession	This session provides methods to retrieve Participant to Catalogue mappings.
ParticipantForm	This is the form for creating and updating Participant objects.
ParticipantList	Like all OsidLists, ParticipantList provides a means for accessing Participant elements sequentially either one at a time or many at a time.
ParticipantLookupSession	This session defines methods for retrieving participants.
ParticipantNotificationSession	This session defines methods to receive notifications on adds/changes to Participant objects.
ParticipantQuery	This is the query for searching participants.
ParticipantQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
ParticipantQuerySession	This session provides methods for querying Participant objects.
ParticipantReceiver	The participant receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted participants.
ParticipantSearch	The search interface for governing participant searches.
ParticipantSearchOrder	An interface for specifying the ordering of search results.
ParticipantSearchResults	This interface provides a means to capture results of a search.
ParticipantSearchSession	This session provides methods for searching Participant objects.
ParticipantSmartCatalogueSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Result	An Result is an outcome from a Participation.
ResultAdminSession	This session creates, updates, and deletes Results.
ResultCatalogueAssignmentSession	This session provides methods to re-assign Results to Bilings.
ResultCatalogueSession	This session provides methods to retrieve Result to Catalogue mappings.
ResultForm	This is the form for creating and updating Result objects.
ResultList	Like all OsidLists, ResultList provides a means for accessing Result elements sequentially either one at a time or many at a time.
ResultLookupSession	This session defines methods for retrieving results.
ResultNotificationSession	This session defines methods to receive notifications on adds/changes to Result objects.
ResultQuery	This is the query for searching results.
ResultQueryInspector	The query inspectors provide a means of accessing the match terms of a query.
ResultQuerySession	This session provides methods for querying Result objects.
ResultReceiver	The result receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted results.
ResultSearch	The search interface for governing result searches.
ResultSearchOrder	An interface for specifying the ordering of search results.
ResultSearchResults	This interface provides a means to capture results of a search.
ResultSearchSession	This session provides methods for searching Result objects.
ResultSmartCatalogueSession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Package org.osid.offering Description

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

The Offering OSID defines a means for managing offerings of things, participants in offerings, and their results. This is an OSID expression of the Kuali Student core model.

Offering

An Offering is any deliverable. Offerings define the logistics of the deliverable such as the Schedule . Offerings are offered in a TimePeriod.

CanonincalUnit

A CanonicalUnit is the approved item to be offered. All Offerings are offered from a CanonicalUnit. The CanonicalUnit describes what is offered and the Offering captures the logistics.

Participant

A Participant is an OsidRelationship used to associated a Resource to an Offering.

Result

The Result is any outcome as a result of a Participation in an Offering. Each Participant may have multiple Results of different types of within sub- TimePeriods . Results references Grades which are constrained by their GradingSystems. GradeSystems may be defined for various purposes, including constrained numeric results and enumerated certifications.

Example

The Offering OSID may be used as an abstract layer for the Course OSID where the CanonicalUnits are Courses, Offerings are CourseOfferings, Participants are instructors and CourseRegistrations, and Results are Grades.

The Offering OSID may be used to describe other offerings. For example, an airline route is a CanonicalUnit, a flight at a particular time is an Offering, a reservation is a Participant, and the frequent flyer miles awarded is a Result .

Catalogue Cataloging

CanonicalUnits, Offerings, Participants , and Results are mapped to Catalogues for offering. Catalogues can be managed hierarchically to federate multiple collections of CanonicalUnits .

Every Catalogue has one offering hierarchy. By selecting the Catalogue is, in effect, selecting the offeringal hierarchy. Each hierarchy may expose multiple offeringal roots that do not have to be related. Looking up and searching Offerings exposes all of their offeringal units. It may be helpful to retrieve the offeringal roots for a Catalogue and navigating from there.

Sub Packages

The Offering OSID contains an Offering Rules OSID for managing the offering rules of CanonicalUnits and an Offering Batch OSID for creating, updating, and deleting CanonicalUnits, Offerings, Participants, and Results in bulk.

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