Interface ObjectiveSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ObjectiveSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ObjectiveQueryInspector	getObjectiveQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ObjectiveList	getObjectives()	Gets the objective list resulting from the search.
ObjectiveSearchResultsRecord	getObjectiveSearchResultsRecord(Type objectiveSearchRecordType)	Gets the objective search results record corresponding to the given objective 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

getObjectives

ObjectiveList getObjectives()

Gets the objective list resulting from the search.

Returns:

the objective list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getObjectiveQueryInspector

ObjectiveQueryInspector getObjectiveQueryInspector()

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.

getObjectiveSearchResultsRecord

ObjectiveSearchResultsRecord getObjectiveSearchResultsRecord(Type objectiveSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

objectiveSearchRecordType - an objective search record type

Returns:

the objective search results record

Throws:

NullArgumentException - objectiveSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasSearchRecordType(objectiveSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.