Interface | osid.subscription.PublisherSearchSession | ||
---|---|---|---|
Implements | osid.subscription.PublisherQuerySession | ||
Description |
This session provides methods for searching Publishers may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getPublisherSearch | ||
Description |
Gets a publisher search. | ||
Return | osid.subscription.PublisherSearch | the publisher search | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublisherSearchOrder | ||
Description |
Gets a publisher search order. The | ||
Return | osid.subscription.PublisherSearchOrder | the publisher search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublishersBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.subscription.PublisherQuery | publisherQuery | the publisher query |
osid.subscription.PublisherSearch | publisherSearch | the publisher search | |
Return | osid.subscription.PublisherSearchResults | the publisher search results | |
Errors | NULL_ARGUMENT | publisherQuery or publisherSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | publisherQuery or publisherSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPublisherQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.subscription.PublisherQueryInspector | publisherQueryInspector | a query inspector |
Return | osid.subscription.PublisherQuery | the entry query | |
Errors | NULL_ARGUMENT | publisherQueryInspector is null | |
UNSUPPORTED | publisherQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |