Interface ObstacleSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ObstacleSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ObstacleQueryInspector	getObstacleQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ObstacleList	getObstacles()	Gets the obstacle list resulting from a search.
ObstacleSearchResultsRecord	getObstacleSearchResultsRecord(Type obstacleSearchRecordType)	Gets the record corresponding to the given obstacle 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

getObstacles

ObstacleList getObstacles()

Gets the obstacle list resulting from a search.

Returns:

the obstacle list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getObstacleQueryInspector

ObstacleQueryInspector getObstacleQueryInspector()

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

Returns:

the obstacle query inspector

Compliance:

mandatory - This method must be implemented.

getObstacleSearchResultsRecord

ObstacleSearchResultsRecord getObstacleSearchResultsRecord(Type obstacleSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

obstacleSearchRecordType - an obstacle search record type

Returns:

the obstacle search results record

Throws:

NullArgumentException - obstacleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.