public interface CategorySearch extends OsidSearch
The search interface for governing category searches.
Modifier and Type | Method and Description |
---|---|
CategorySearchRecord |
getCategorySearchRecord(Type categorySearchRecordType)
Gets the category search record corresponding to the given category
search record
Type. |
void |
orderCategoryResults(CategorySearchOrder categorySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCategories(IdList categoryIds)
Execute this search among the given list of categories.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCategories(IdList categoryIds)
categoryIds
- list of customersNullArgumentException
- categoryIds
is
null
mandatory
- This method must be implemented. void orderCategoryResults(CategorySearchOrder categorySearchOrder)
categorySearchOrder
- customer search orderNullArgumentException
- categorySearchOrder
is null
UnsupportedException
- categorySearchOrder
is not of this servicemandatory
- This method must be implemented. CategorySearchRecord getCategorySearchRecord(Type categorySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.categorySearchRecordType
- a customer search record typeNullArgumentException
- categorySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(categorySearchRecordType)
is
false
mandatory
- This method must be implemented.