OSID Logo
OSID Specifications
subscription package
Version 3.1.0
Interfaceosid.subscription.PublisherQuerySession
Implementsosid.OsidSession
Implemented Byosid.subscription.PublisherSearchSession
Used Byosid.subscription.SubscriptionManager
osid.subscription.SubscriptionProxyManager
Description

This session provides methods for searching Publishers. 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
Compliancemandatory This method must be implemented.
MethodgetPublisherQuery
Description

Gets a publisher query.

Returnosid.subscription.PublisherQuery the publisher query
Compliancemandatory This method must be implemented.
MethodgetPublishersByQuery
Description

Gets a list of Publishers matching the given publisher query.

Parametersosid.subscription.PublisherQuerypublisherQuery the publisher query
Returnosid.subscription.PublisherList the returned PublisherList
ErrorsNULL_ARGUMENT publisherQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED publisherQuery is not of this service
Compliancemandatory This method must be implemented.