OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.PublisherSearch
Implementsosid.OsidSearch
Description

The search interface for governing publisher searches.

MethodsearchAmongPublishers
Description

Execute this search among the given list of publishers.

Parametersosid.id.IdListpublisherIdslist of publishers
ErrorsNULL_ARGUMENT publisherIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPublisherResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.PublisherSearchOrderpublishersearchOrderpublisher search order
ErrorsNULL_ARGUMENT publishersearchOrder is null
UNSUPPORTED publishersearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPublisherSearchRecord
Description

Gets the publisher search 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.PublisherSearchRecordthe publisher search record
ErrorsNULL_ARGUMENT publishersearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(publishersearchRecordType) is false
CompliancemandatoryThis method must be implemented.