org.osid.mapping.path.rules

Interface ObstacleEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ObstacleEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ObstacleEnablerQueryInspector	getObstacleEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ObstacleEnablerList	getObstacleEnablers() Gets the ObstacleEnablerList resulting from a search.
ObstacleEnablerSearchResultsRecord	getObstacleEnablerSearchResultsRecord(Type obstacleEnablerSearchRecordType) Gets the obstacle enabler search results record corresponding to the given obstacle enabler search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getObstacleEnablers

ObstacleEnablerList getObstacleEnablers()

Gets the ObstacleEnablerList resulting from a search.

Returns:

the obstacle enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerQueryInspector

ObstacleEnablerQueryInspector getObstacleEnablerQueryInspector()

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

Returns:

the obstacle enabler query inspector

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerSearchResultsRecord

ObstacleEnablerSearchResultsRecord getObstacleEnablerSearchResultsRecord(Type obstacleEnablerSearchRecordType)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

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

Parameters:

obstacleEnablerSearchRecordType - an obstacle enabler search record type

Returns:

the obstacle enabler search results record

Throws:

NullArgumentException - obstacleEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(obstacleEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.