Package org.osid.subscription

package org.osid.subscription

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

The Subscription OSID provides a means for subscribing to communications. Subscribers are represented by Resources . A Subscription service implicitly uses the Contact OSID for accessing Addresses for a Resource subscriber.

Dispatches

A Dispatch represents something subscribed. A Dispatch may restrict the Address Types usable by the Resource subscriber in a Subscription .

Subscriptions

A Subscription is an OsidRelationship between a Resource and a Dispatch . A Subscription is effective in a period of time of governed by an external set of Rules .

Publisher Cataloging

Dispatches and Subscriptions may be organized into federateable OsidCatalogs of Publishers .

Sub Packages

The Subscription OSID includes a Subscription Rules OSID for managing effectiveness and subscription constraints on a Dispatch .

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

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.subscription.batch	The Open Service Interface Definitions for the org.osid.subscription.batch service.
org.osid.subscription.records
org.osid.subscription.rules	The Open Service Interface Definitions for the org.osid.subscription.rules service.

Interfaces

Class	Description
Dispatch	A Dispatch represents a collection of subscriptions.
DispatchAdminSession	This session creates, updates, and deletes Dispatches .
DispatchForm	This is the form for creating and updating Dispatches .
DispatchList	Like all OsidLists , DispatchList provides a means for accessing Dispatch elements sequentially either one at a time or many at a time.
DispatchLookupSession	This session provides methods for retrieving Dispatches .
DispatchNotificationSession	This session defines methods to receive notifications on adds/changes to Dispatches .
DispatchPublisherAssignmentSession	This session provides methods to re-assign Dispatches to Publishers .
DispatchPublisherSession	This session provides methods to retrieve Dispatch to Publisher mappings.
DispatchQuery	This is the query for searching for dispatches.
DispatchQueryInspector	This is the query inspector for examining for dispatch queries.
DispatchQuerySession	This session provides methods for searching Dispatches .
DispatchReceiver	The dispatch receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Dispatch objects.
DispatchSearch	The search interface for governing dispatch searches.
DispatchSearchOrder	An interface for specifying the ordering of search results.
DispatchSearchResults	This interface provides a means to capture results of a search.
DispatchSearchSession	This session provides methods for searching Dispatches .
DispatchSmartPublisherSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
MySubscriptionAdminSession	This session creates and removes subscriptions foe the authenticated Agent .
MySubscriptionSession	This session defines methods for retrieving subscriptions.
Publisher	A Publisher represents a collection of subscriptions.
PublisherAdminSession	This session creates and removes publishers.
PublisherForm	This is the form for creating and updating Publishers .
PublisherHierarchyDesignSession	This session manages a hierarchy of publishers.
PublisherHierarchySession	This session defines methods for traversing a hierarchy of Publishers .
PublisherList	Like all OsidLists , PublisherList provides a means for accessing Publisher elements sequentially either one at a time or many at a time.
PublisherLookupSession	This session provides methods for retrieving Publishers .
PublisherNode	This interface is a container for a partial hierarchy retrieval.
PublisherNodeList	Like all OsidLists , PublisherNodeList provides a means for accessing PublisherNode elements sequentially either one at a time or many at a time.
PublisherNotificationSession	This session defines methods to receive notifications on adds/changes to Publishers .
PublisherQuery	This is the query for searching for publishers.
PublisherQueryInspector	This is the query inspector for examining for publisher queries.
PublisherQuerySession	This session provides methods for searching Publishers .
PublisherReceiver	The publisher receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Publisher objects.
PublisherSearch	The search interface for governing publisher searches.
PublisherSearchOrder	An interface for specifying the ordering of search results.
PublisherSearchResults	This interface provides a means to capture results of a search.
PublisherSearchSession	This session provides methods for searching Publishers .
Subscription	A Subscription relates a subscriber to a Dispatch and also contains the subscriber's Address to use as the means of contact in this context.
SubscriptionAdminSession	This session creates, updates, and deletes Subscriptions .
SubscriptionForm	This is the form for creating and updating Subscriptions .
SubscriptionList	Like all OsidLists , SubscriptionList provides a means for accessing Subscription elements sequentially either one at a time or many at a time.
SubscriptionLookupSession	This session defines methods for retrieving subscriptions.
SubscriptionManager	The subscription manager provides access to subscription sessions and provides interoperability tests for various aspects of this service.
SubscriptionNotificationSession	This session defines methods to receive notifications on adds/changes to Subscriptions .
SubscriptionProfile	The subscription profile describes the interoperability among subscription services.
SubscriptionProxyManager	The subscription manager provides access to subscription sessions and provides interoperability tests for various aspects of this service.
SubscriptionPublisherAssignmentSession	This session provides methods to re-assign Subscriptions to Publishers .
SubscriptionPublisherSession	This session provides methods to retrieve Subscription to Publisher mappings.
SubscriptionQuery	This is the query for searching subscriptions.
SubscriptionQueryInspector	The query inspector for examining subscription queries.
SubscriptionQuerySession	This session provides methods for searching Subscriptions .
SubscriptionReceiver	The subscription receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted subscriptions.
SubscriptionSearch	The search interface for governing subscription searches.
SubscriptionSearchOrder	An interface for specifying the ordering of search results.
SubscriptionSearchResults	This interface provides a means to capture results of a search.
SubscriptionSearchSession	This session provides methods for searching Subscriptions .
SubscriptionSmartPublisherSession	This session manages queries and sequencing to create "smart" dynamic catalogs.