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

This session manages queries and sequencing to create "smart" dynamic catalogs. A DispatchQuery can be retrieved from this session and mapped to this Publisher to create a virtual collection of Dispatches. The dispatches may be sequenced using the DispatchSearchOrder from this session.

This Publisher has a default query that matches any dispatch and a default search order that specifies no sequencing. The queries may be examined using a DispatchQueryInspector. The query may be modified by converting the inspector back to a DispatchQuery.

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 associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartPublishers
Description

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

Returnboolean false if smart publisher management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDispatchQuery
Description

Gets a dispatch query.

Returnosid.subscription.DispatchQuerythe dispatch query
CompliancemandatoryThis method must be implemented.
MethodgetDispatchSearchOrder
Description

Gets a dispatch search order.

Returnosid.subscription.DispatchSearchOrderthe dispatch search order
CompliancemandatoryThis method must be implemented.
MethodapplyDispatchQuery
Description

Applies a dispatch query to this publisher.

Parametersosid.subscription.DispatchQuerydispatchQuerythe dispatch query
ErrorsNULL_ARGUMENT dispatchQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED dispatchQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectDispatchQuery
Description

Gets a dispatch query inspector for this publisher.

Returnosid.subscription.DispatchQueryInspectorthe dispatch query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyDispatchSequencing
Description

Applies a dispatch search order to this publisher.

Parametersosid.subscription.DispatchSearchOrderdispatchSearchOrderthe dispatch search order
ErrorsNULL_ARGUMENT dispatchSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED dispatchSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDispatchQueryFromInspector
Description

Gets a dispatch query from an inspector.

Parametersosid.subscription.DispatchQueryInspectordispatchQueryInspectora query inspector
Returnosid.subscription.DispatchQuerythe dispatch query
ErrorsNULL_ARGUMENT dispatchQueryInspector is null
UNSUPPORTED dispatchQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.