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

This session provides methods for searching Publisher objects. The search query is constructed using the PublisherQuery. The publisher record Type also specifies the record for the publisher query.

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

MethodcanSearchPublishers
Description

Tests if this user can perform Publisher 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.
MethodgetPublisherQuery
Description

Gets a publisher query.

Returnosid.subscription.PublisherQuerythe publisher query
CompliancemandatoryThis method must be implemented.
MethodgetPublishersByQuery
Description

Gets a list of Publishers matching the given publisher query.

Parametersosid.subscription.PublisherQuerypublisherQuerythe publisher query
Returnosid.subscription.PublisherListthe returned PublisherList
ErrorsNULL_ARGUMENT publisherQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED publisherQuery is not of this service
CompliancemandatoryThis method must be implemented.