Interface | osid.subscription.PublisherSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing publisher searches. | ||
Method | searchAmongPublishers | ||
Description |
Execute this search among the given list of publishers. | ||
Parameters | osid.id.IdList | publisherIds | list of publishers |
Errors | NULL_ARGUMENT | publisherIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderPublisherResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.subscription.PublisherSearchOrder | publishersearchOrder | publisher search order |
Errors | NULL_ARGUMENT | publishersearchOrder is null | |
UNSUPPORTED | publishersearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPublisherSearchRecord | ||
Description |
Gets the publisher search record corresponding to the
given publisher search record | ||
Parameters | osid.type.Type | publisherSearchRecordType | a publisher search record type |
Return | osid.subscription.records.PublisherSearchRecord | the publisher search record | |
Errors | NULL_ARGUMENT | publishersearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(publishersearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |