Interface CommissionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CommissionSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CommissionQueryInspector	getCommissionQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CommissionList	getCommissions()	Gets the commission list resulting from a search.
CommissionSearchResultsRecord	getCommissionSearchResultsRecord(Type commissionSearchRecordType)	Gets the commission search results record corresponding to the given commission search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getCommissions

CommissionList getCommissions()

Gets the commission list resulting from a search.

Returns:

the commission list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCommissionQueryInspector

CommissionQueryInspector getCommissionQueryInspector()

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

Returns:

the commission query inspector

Compliance:

mandatory - This method must be implemented.

getCommissionSearchResultsRecord

CommissionSearchResultsRecord getCommissionSearchResultsRecord(Type commissionSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

commissionSearchRecordType - a commission search record type

Returns:

the commission search results record

Throws:

NullArgumentException - commissionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commissionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.