Interface ResourceSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ResourceSearch
extends OsidSearch

The search interface for governing resource searches.

Method Summary

Modifier and Type	Method	Description
ResourceSearchRecord	getResourceSearchRecord(Type resourceSearchRecordType)	Gets the resource search record corresponding to the given resource search record Type.
void	orderResourceResults(ResourceSearchOrder resourceSearchOrder)	Specify an ordering to the search results.
void	searchAmongResources(IdList resourceIds)	Execute this search among the given list of resources.

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

searchAmongResources

void searchAmongResources(IdList resourceIds)

Execute this search among the given list of resources.

Parameters:

resourceIds - list of resource Ids

Throws:

NullArgumentException - resourceIds is null

Compliance:

mandatory - This method must be implemented.

orderResourceResults

void orderResourceResults(ResourceSearchOrder resourceSearchOrder)

Specify an ordering to the search results.

Parameters:

resourceSearchOrder - resource search order

Throws:

NullArgumentException - order is null

UnsupportedException - order is not of this service

Compliance:

mandatory - This method must be implemented.

getResourceSearchRecord

ResourceSearchRecord getResourceSearchRecord(Type resourceSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

resourceSearchRecordType - a resource search record type

Returns:

the resource search record

Throws:

NullArgumentException - resourceSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(resourceSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.