OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.PublisherSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetPublishers
Description

Gets the publisher list resulting from a search.

Returnosid.subscription.PublisherListthe publisher list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPublisherQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.subscription.PublisherQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPublisherSearchResultsRecord
Description

Gets the publisher search results record corresponding to the given publisher search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypepublisherSearchRecordTypea publisher search record type
Returnosid.subscription.records.PublisherSearchResultsRecordthe publisher search results record
ErrorsNULL_ARGUMENT publisherSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(publisherSearchRecordType) is false
CompliancemandatoryThis method must be implemented.