org.osid.topology.path

Interface PathSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PathSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
PathQueryInspector	getPathQueryInspector() Gets the inspector for the query to examine the terms used in the search.
PathList	getPaths() Gets the path list resulting from a search.
PathSearchResultsRecord	getPathSearchResultsRecord(Type pathSearchRecordType) Gets thepath search results record corresponding to the given path 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

getPaths

PathList getPaths()

Gets the path list resulting from a search.

Returns:

the path list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getPathQueryInspector

PathQueryInspector getPathQueryInspector()

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

Returns:

the path query inspector

Compliance:

mandatory - This method must be implemented.

getPathSearchResultsRecord

PathSearchResultsRecord getPathSearchResultsRecord(Type pathSearchRecordType)
                                                   throws OperationFailedException

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

Parameters:

pathSearchRecordType - a path search record type

Returns:

the path search results record

Throws:

NullArgumentException - pathSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pathSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.