public interface CatalogSearch extends OsidSearch
The search interface for governing the search query for
Catalogs.
Modifier and Type | Method and Description |
---|---|
CatalogSearchRecord |
getCatalogSearchRecord(Type catalogSearchRecordType)
Gets the catalog search record corresponding to the given catalog
search record
Type. |
void |
orderCatalogResults(CatalogSearchOrder catalogSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCatalogs(IdList catalogIds)
Execute this search among the given list of catalogs.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCatalogs(IdList catalogIds)
catalogIds
- list of catalogsNullArgumentException
- catalogIds
is
null
mandatory
- This method must be implemented. void orderCatalogResults(CatalogSearchOrder catalogSearchOrder)
catalogSearchOrder
- catalog search orderNullArgumentException
- catalogSearchOrder
is null
UnsupportedException
- catalogSearchOrder
is not of this servicemandatory
- This method must be implemented. CatalogSearchRecord getCatalogSearchRecord(Type catalogSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.catalogSearchRecordType
- a catalog search record typeNullArgumentException
- catalogSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(catalogSearchRecordType)
is false
mandatory
- This method must be implemented.