org.osid.mapping.path

Interface IntersectionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface IntersectionSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
IntersectionQueryInspector	getIntersectionQueryInspector() Gets the inspector for the query to examine the terms used in the search.
IntersectionList	getIntersections() Gets the intersection list resulting from a search.
IntersectionSearchResultsRecord	getIntersectionSearchResultsRecord(Type intersectionSearchRecordType) Gets the intersection search results record corresponding to the given intersection 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

getIntersections

IntersectionList getIntersections()

Gets the intersection list resulting from a search.

Returns:

the intersection list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getIntersectionQueryInspector

IntersectionQueryInspector getIntersectionQueryInspector()

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

Returns:

the intersection query inspector

Compliance:

mandatory - This method must be implemented.

getIntersectionSearchResultsRecord

IntersectionSearchResultsRecord getIntersectionSearchResultsRecord(Type intersectionSearchRecordType)
                                                                   throws OperationFailedException

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

Parameters:

intersectionSearchRecordType - a intersection search record type

Returns:

the intersection search results record

Throws:

NullArgumentException - intersectionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(intersectionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.