public interface CategorySearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CategoryList |
getCategories()
Gets the category list resulting from a search.
|
CategoryQueryInspector |
getCategoryQueryInspector()
Gets the inspector for the query to examine the periods used in the
search.
|
CategorySearchResultsRecord |
getCategorySearchResultsRecord(Type categorySearchRecordType)
Gets the category search results record corresponding to the given
category search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CategoryList getCategories()
IllegalStateException
- the category list has already
been retrievedmandatory
- This method must be implemented. CategoryQueryInspector getCategoryQueryInspector()
mandatory
- This method must be implemented. CategorySearchResultsRecord getCategorySearchResultsRecord(Type categorySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.categorySearchRecordType
- a category search record typeNullArgumentException
- categorySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(categorySearchRecordType)
is
false
mandatory
- This method must be implemented.