Interface GraphSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface GraphSearch
extends OsidSearch

The search interface for governing graph searches.

Method Summary

Modifier and Type	Method	Description
GraphSearchRecord	getGraphSearchRecord(Type graphSearchRecordType)	Gets the graph search record corresponding to the given graph search record Type.
void	orderGraphResults(GraphSearchOrder graphSearchOrder)	Specify an ordering to the search results.
void	searchAmongGraphs(IdList graphIds)	Execute this search among the given list of graphs.

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

searchAmongGraphs

void searchAmongGraphs(IdList graphIds)

Execute this search among the given list of graphs.

Parameters:

graphIds - list of graphs

Throws:

NullArgumentException - graphIds is null

Compliance:

mandatory - This method must be implemented.

orderGraphResults

void orderGraphResults(GraphSearchOrder graphSearchOrder)

Specify an ordering to the search results.

Parameters:

graphSearchOrder - graph search order

Throws:

NullArgumentException - graphSearchOrder is null

UnsupportedException - graphSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getGraphSearchRecord

GraphSearchRecord getGraphSearchRecord(Type graphSearchRecordType)
                                throws OperationFailedException

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

Parameters:

graphSearchRecordType - a graph search record type

Returns:

the graph search record

Throws:

NullArgumentException - graphSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.