Interface DirectionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DirectionSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DirectionQueryInspector	getDirectionQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
DirectionList	getDirections()	Gets the direction list resulting from a search.
DirectionSearchResultsRecord	getDirectionSearchResultsRecord(Type directionSearchRecordType)	Gets the direction search results record corresponding to the given direction 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

getDirections

DirectionList getDirections()

Gets the direction list resulting from a search.

Returns:

the direction list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getDirectionQueryInspector

DirectionQueryInspector getDirectionQueryInspector()

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

Returns:

the direction query inspector

Compliance:

mandatory - This method must be implemented.

getDirectionSearchResultsRecord

DirectionSearchResultsRecord getDirectionSearchResultsRecord(Type directionSearchRecordType)
                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

directionSearchRecordType - a direction search record type

Returns:

the direction search results record

Throws:

NullArgumentException - directionSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(directionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.