OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.DispatchLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Dispatch objects. The Dispatch represents a collection of subscriptions.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated publisher view: All subscription methods in this session operate, retrieve and pertain to dispatches defined explicitly in the current publisher. Using an isolated view is useful for managing dispatches with the DispatchAdminSession.
  • federated publisher view: All subscription lookup methods in this session operate, retrieve and pertain to all dispatches defined in this publisher and any other publishers implicitly available in this publisher through publisher inheritence.
  • active dispatch view: All dispatch lookup methods return active dispatches.
  • any status dispatch view: Dispatches of any active or inactive status are returned from methods.
MethodgetPublisherId
Description

Gets the Publisher Id associated with this session.

Returnosid.id.Idthe Publisher Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPublisher
Description

Gets the Publisher associated with this session.

Returnosid.subscription.Publisherthe publisher
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupDispatches
Description

Tests if this user can perform Dispatch lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDispatchView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryDispatchView
Description

A complete view of the Dispatch returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedPublisherView
Description

Federates the view for methods in this session. A federated view will include dispatches in publishers which are children of this publisher in the publisher hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPublisherView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this publisher only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveDispatchView
Description

Only active dispatches are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusDispatchView
Description

All active and inactive dispatches are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetDispatch
Description

Gets the Dispatch specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Dispatch may have a different Id than requested, such as the case where a duplicate Id was assigned to a Dispatch and retained for compatibility.

In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.

Parametersosid.id.IddispatchId Id of the Dispatch
Returnosid.subscription.Dispatchthe dispatch
ErrorsNOT_FOUND dispatchId not found
NULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetDispatchesByIds
Description

Gets a DispatchList corresponding to the given IdList.

In plenary mode, the returned list contains all of the dispatches specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Dispatches may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.

Parametersosid.id.IdListdispatchIdsthe list of Ids to retrieve
Returnosid.subscription.DispatchListthe returned Dispatch list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT dispatchIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatchesByGenusType
Description

Gets a DispatchList corresponding to the given dispatch genus Type which does not include dispatches of genus types derived from the specified Type.

In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session.

In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.

Parametersosid.type.TypedispatchGenusTypea dispatch genus type
Returnosid.subscription.DispatchListthe returned Dispatch list
ErrorsNULL_ARGUMENT dispatchGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatchesByParentGenusType
Description

Gets a DispatchList corresponding to the given dispatch genus Type and include any additional dispatches with genus types derived from the specified Type.

In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session.

In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.

Parametersosid.type.TypedispatchGenusTypea dispatch genus type
Returnosid.subscription.DispatchListthe returned Dispatch list
ErrorsNULL_ARGUMENT dispatchGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatchesByRecordType
Description

Gets a DispatchList containing the given dispatch record Type.

In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session.

In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.

Parametersosid.type.TypedispatchRecordTypea dispatch record type
Returnosid.subscription.DispatchListthe returned Dispatch list
ErrorsNULL_ARGUMENT dispatchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatchesByProvider
Description

Gets a DispatchList for the given provider.

In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session.

In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.subscription.DispatchListthe returned Dispatch list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDispatches
Description

Gets all Dispatches.

In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session.

In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.

Returnosid.subscription.DispatchLista list of Dispatches
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.