Interface EndpointSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EndpointSearch
extends OsidSearch

The interface for governing endpoint searches.

Method Summary

Modifier and Type	Method	Description
EndpointSearchRecord	getEndpointSearchRecord(Type endpointSearchRecordType)	Gets the endpoint search record corresponding to the given endpoint search record Type.
void	orderEndpointResults(EndpointSearchOrder endpointSearchOrder)	Specify an ordering to the search results.
void	searchAmongEndpoints(IdList endpointIds)	Execute this search among the given list of endpoints.

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

searchAmongEndpoints

void searchAmongEndpoints(IdList endpointIds)

Execute this search among the given list of endpoints.

Parameters:

endpointIds - list of endpoints

Throws:

NullArgumentException - endpointIds is null

Compliance:

mandatory - This method must be implemented.

orderEndpointResults

void orderEndpointResults(EndpointSearchOrder endpointSearchOrder)

Specify an ordering to the search results.

Parameters:

endpointSearchOrder - endpoint search order

Throws:

NullArgumentException - endpointSearchOrder is null

UnsupportedException - endpointSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEndpointSearchRecord

EndpointSearchRecord getEndpointSearchRecord(Type endpointSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

endpointSearchRecordType - a endpoint search record type

Returns:

the endpoint search record

Throws:

NullArgumentException - endpointSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(endpointSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.