OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.PublisherSearchSession
Implementsosid.subscription.PublisherQuerySession
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.

getPublishersByQuery() is the basic search method and returns a list of Publisher elements. A more advanced search may be performed with getPublishersBySearch(). It accepts a PublisherSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPublishersBySearch() returns a PublisherSearchResults that can be used to access the resulting PublisherList or be used to perform a search within the result set through PublisherSearch.

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.

MethodgetPublisherSearch
Description

Gets a publisher search.

Returnosid.subscription.PublisherSearchthe publisher search
CompliancemandatoryThis method must be implemented.
MethodgetPublisherSearchOrder
Description

Gets a publisher search order. The PublisherSearchOrder is supplied to a PublisherSearch to specify the ordering of results.

Returnosid.subscription.PublisherSearchOrderthe publisher search order
CompliancemandatoryThis method must be implemented.
MethodgetPublishersBySearch
Description

Gets the search results matching the given search.

Parametersosid.subscription.PublisherQuerypublisherQuerythe publisher query
osid.subscription.PublisherSearchpublisherSearchthe publisher search
Returnosid.subscription.PublisherSearchResultsthe publisher search results
ErrorsNULL_ARGUMENT publisherQuery or publisherSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED publisherQuery or publisherSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPublisherQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an PublisherSearchResults.

Parametersosid.subscription.PublisherQueryInspectorpublisherQueryInspectora query inspector
Returnosid.subscription.PublisherQuerythe entry query
ErrorsNULL_ARGUMENT publisherQueryInspector is null
UNSUPPORTED publisherQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.