Interface CommissionEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CommissionEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CommissionEnablerQueryInspector	getCommissionEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CommissionEnablerList	getCommissionEnablers()	Gets the CommissionEnablerList resulting from a search.
CommissionEnablerSearchResultsRecord	getCommissionEnablerSearchResultsRecord(Type commissionEnablerSearchRecordType)	Gets the commission enabler search results record corresponding to the given commission enabler search record Type.

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

getCommissionEnablers

CommissionEnablerList getCommissionEnablers()

Gets the CommissionEnablerList resulting from a search.

Returns:

the commission enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCommissionEnablerQueryInspector

CommissionEnablerQueryInspector getCommissionEnablerQueryInspector()

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

Returns:

the commission enabler query inspector

Compliance:

mandatory - This method must be implemented.

getCommissionEnablerSearchResultsRecord

CommissionEnablerSearchResultsRecord getCommissionEnablerSearchResultsRecord(Type commissionEnablerSearchRecordType)
                                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

commissionEnablerSearchRecordType - a commission enabler search record type

Returns:

the commission enabler search results record

Throws:

NullArgumentException - commissionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(commissionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.