Interface LocationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface LocationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
LocationQueryInspector	getLocationQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
LocationList	getLocations()	Gets the location list resulting from a search.
LocationSearchResultsRecord	getLocationSearchResultsRecord(Type locationSearchRecordType)	Gets the record corresponding to the given location 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

getLocations

LocationList getLocations()

Gets the location list resulting from a search.

Returns:

the location list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getLocationQueryInspector

LocationQueryInspector getLocationQueryInspector()

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

Returns:

the location query inspector

Compliance:

mandatory - This method must be implemented.

getLocationSearchResultsRecord

LocationSearchResultsRecord getLocationSearchResultsRecord(Type locationSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

locationSearchRecordType - a location search record type

Returns:

the location search results record

Throws:

NullArgumentException - locationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(locationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.