Interface CategorySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CategorySearch
extends OsidSearch

The search interface for governing category searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongCategories

void searchAmongCategories(IdList categoryIds)

Execute this search among the given list of categories.

Parameters:

categoryIds - list of customers

Throws:

NullArgumentException - categoryIds is null

Compliance:

mandatory - This method must be implemented.

orderCategoryResults

void orderCategoryResults(CategorySearchOrder categorySearchOrder)

Specify an ordering to the search results.

Parameters:

categorySearchOrder - customer search order

Throws:

NullArgumentException - categorySearchOrder is null

UnsupportedException - categorySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCategorySearchRecord

CategorySearchRecord getCategorySearchRecord(Type categorySearchRecordType)
                                      throws OperationFailedException

Gets the category search record corresponding to the given category search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

categorySearchRecordType - a customer search record type

Returns:

the category search record

Throws:

NullArgumentException - categorySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(categorySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.