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

This session provides methods for searching Dispatch objects. The search query is constructed using the DispatchQuery. The dispatch record Type also specifies the record for the dispatch query.

Dispatches may have a query record indicated by their respective record types. The query record is accessed via the DispatchQuery. The returns in this session may not be cast directly to these interfaces.

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

Tests if this user can perform Dispatch searches. 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 opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method 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.
MethodgetDispatchQuery
Description

Gets a dispatch query.

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

Gets a list of Dispatches matching the given dispatch query.

Parametersosid.subscription.DispatchQuerydispatchQuerythe dispatch query
Returnosid.subscription.DispatchListthe returned DispatchList
ErrorsNULL_ARGUMENT dispatchQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED dispatchQuery is not of this service
CompliancemandatoryThis method must be implemented.