Interface EdgeEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EdgeEnablerSearch
extends OsidSearch

The search interface for governing edge enabler searches.

Method Summary

Modifier and Type	Method	Description
EdgeEnablerSearchRecord	getEdgeEnablerSearchRecord(Type edgeEnablerSearchRecordType)	Gets the edge enabler search record corresponding to the given edge enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderEdgeEnablerResults(EdgeEnablerSearchOrder edgeEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongEdgeEnablers(IdList edgeEnablerIds)	Execute this search among the given list of edge enablers.

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

searchAmongEdgeEnablers

void searchAmongEdgeEnablers(IdList edgeEnablerIds)

Execute this search among the given list of edge enablers.

Parameters:

edgeEnablerIds - list of edge enablers

Throws:

NullArgumentException - edgeEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderEdgeEnablerResults

void orderEdgeEnablerResults(EdgeEnablerSearchOrder edgeEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

edgeEnablerSearchOrder - edge enabler search order

Throws:

NullArgumentException - edgeEnablerSearchOrder is null

UnsupportedException - edgeEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerSearchRecord

EdgeEnablerSearchRecord getEdgeEnablerSearchRecord(Type edgeEnablerSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

edgeEnablerSearchRecordType - an edge enabler search record type

Returns:

the edge enabler search record

Throws:

NullArgumentException - edgeEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.