Interface NodeSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface NodeSearch
extends OsidSearch

The search interface for governing node searches.

Method Summary

Modifier and Type	Method	Description
NodeSearchRecord	getNodeSearchRecord(Type nodeSearchRecordType)	Gets the node search record corresponding to the given node search record Type.
void	orderNodeResults(NodeSearchOrder nodeSearchOrder)	Specify an ordering to the search results.
void	searchAmongNodes(IdList nodeIds)	Execute this search among the given list of nodes.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongNodes

void searchAmongNodes(IdList nodeIds)

Execute this search among the given list of nodes.

Parameters:

nodeIds - list of nodes

Throws:

NullArgumentException - nodeIds is null

Compliance:

mandatory - This method must be implemented.

orderNodeResults

void orderNodeResults(NodeSearchOrder nodeSearchOrder)

Specify an ordering to the search results.

Parameters:

nodeSearchOrder - node search order

Throws:

NullArgumentException - nodeSearchOrder is null

UnsupportedException - nodeSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getNodeSearchRecord

NodeSearchRecord getNodeSearchRecord(Type nodeSearchRecordType)
                              throws OperationFailedException

Gets the node search 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 record

Throws:

NullArgumentException - nodeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(nodeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.