Interface | osid.offering.CatalogueSearchSession | ||
---|---|---|---|
Implements | osid.offering.CatalogueQuerySession | ||
Description |
This session provides methods for searching Catalogues may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCatalogueSearch | ||
Description |
Gets a catalogue search. | ||
Return | osid.offering.CatalogueSearch | the catalogue search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueSearchOrder | ||
Description |
Gets a catalogue search order. The | ||
Return | osid.offering.CatalogueSearchOrder | the catalogue search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCataloguesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.offering.CatalogueQuery | catalogueQuery | the catalogue query |
osid.offering.CatalogueSearch | catalogueSearch | the catalogue search | |
Return | osid.offering.CatalogueSearchResults | the search results | |
Errors | NULL_ARGUMENT | catalogueQuery or catalogueSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | catalogueQuery or catalogueSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueQueryFromInspector | ||
Description |
Gets a catalogue query from an inspector. The inspector
is available from a | ||
Parameters | osid.offering.CatalogueQueryInspector | catalogueQueryInspector | a catalogue query inspector |
Return | osid.offering.CatalogueQuery | the catalogue query | |
Errors | NULL_ARGUMENT | catalogueQueryInspector is null | |
UNSUPPORTED | icatalogueQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |