Interface EdgeSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EdgeSearch
extends OsidSearch

The search interface for governing edge searches.

Method Summary

Modifier and Type	Method	Description
EdgeSearchRecord	getEdgeSearchRecord(Type edgeSearchRecordType)	Gets the edge search record corresponding to the given edge search record Type.
void	orderEdgeResults(EdgeSearchOrder edgeSearchOrder)	Specify an ordering to the search results.
void	searchAmongEdges(IdList edgeIds)	Execute this search among the given list of edges.

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

searchAmongEdges

void searchAmongEdges(IdList edgeIds)

Execute this search among the given list of edges.

Parameters:

edgeIds - list of edges

Throws:

NullArgumentException - edgeIds is null

Compliance:

mandatory - This method must be implemented.

orderEdgeResults

void orderEdgeResults(EdgeSearchOrder edgeSearchOrder)

Specify an ordering to the search results.

Parameters:

edgeSearchOrder - edge search order

Throws:

NullArgumentException - edgeSearchOrder is null

UnsupportedException - edgeSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEdgeSearchRecord

EdgeSearchRecord getEdgeSearchRecord(Type edgeSearchRecordType)
                              throws OperationFailedException

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

Parameters:

edgeSearchRecordType - an edge search record type

Returns:

the edge search record

Throws:

NullArgumentException - edgeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.