Interface ObjectiveBankSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ObjectiveBankSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ObjectiveBankQueryInspector	getObjectiveBankQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ObjectiveBankList	getObjectiveBanks()	Gets the objective bank list resulting from the search.
ObjectiveBankSearchResultsRecord	getObjectiveBankSearchResultsRecord(Type objectiveBankSearchRecordType)	Gets the objective bank search results record corresponding to the given objective bank 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

getObjectiveBanks

ObjectiveBankList getObjectiveBanks()

Gets the objective bank list resulting from the search.

Returns:

the objective bank list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getObjectiveBankQueryInspector

ObjectiveBankQueryInspector getObjectiveBankQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getObjectiveBankSearchResultsRecord

ObjectiveBankSearchResultsRecord getObjectiveBankSearchResultsRecord(Type objectiveBankSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

objectiveBankSearchRecordType - an objective bank search record type

Returns:

the objective bank search results record

Throws:

NullArgumentException - objectiveBankSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasSearchRecordType(objective bankSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.