Interface NodeSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface NodeSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
NodeQueryInspector	getNodeQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
NodeList	getNodes()	Gets the node list resulting from a search.
NodeSearchResultsRecord	getNodeSearchResultsRecord(Type nodeSearchRecordType)	Gets the node search results record corresponding to the given node 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

getNodes

NodeList getNodes()

Gets the node list resulting from a search.

Returns:

the node list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getNodeQueryInspector

NodeQueryInspector getNodeQueryInspector()

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

Returns:

the node query inspector

Compliance:

mandatory - This method must be implemented.

getNodeSearchResultsRecord

NodeSearchResultsRecord getNodeSearchResultsRecord(Type nodeSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

nodeSearchRecordType - a node search record type

Returns:

the node search results record

Throws:

NullArgumentException - nodeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(nodeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.