org.osid.billing

Interface CategorySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CategorySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getCategories

CategoryList getCategories()

Gets the category list resulting from a search.

Returns:

the category list

Throws:

IllegalStateException - the category list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCategoryQueryInspector

CategoryQueryInspector getCategoryQueryInspector()

Gets the inspector for the query to examine the periods used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCategorySearchResultsRecord

CategorySearchResultsRecord getCategorySearchResultsRecord(Type categorySearchRecordType)
                                                           throws OperationFailedException

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

Parameters:

categorySearchRecordType - a category search record type

Returns:

the category search results record

Throws:

NullArgumentException - categorySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(categorySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.