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

Modifier and Type	Method	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 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

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.