Interface CheckSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CheckSearch
extends OsidSearch

The search interface for governing check searches.

Method Summary

Modifier and Type	Method	Description
CheckSearchRecord	getCheckSearchRecord(Type checkSearchRecordType)	Gets the check search record corresponding to the given check search record Type .
void	orderCheckResults(CheckSearchOrder checkSearchOrder)	Specify an ordering to the search results.
void	searchAmongChecks(IdList checkIds)	Execute this search among the given list of checks.

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

searchAmongChecks

void searchAmongChecks(IdList checkIds)

Execute this search among the given list of checks.

Parameters:

checkIds - list of checks

Throws:

NullArgumentException - checkIds is null

Compliance:

mandatory - This method must be implemented.

orderCheckResults

void orderCheckResults(CheckSearchOrder checkSearchOrder)

Specify an ordering to the search results.

Parameters:

checkSearchOrder - check search order

Throws:

NullArgumentException - checkSearchOrder is null

UnsupportedException - checkSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCheckSearchRecord

CheckSearchRecord getCheckSearchRecord(Type checkSearchRecordType)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

checkSearchRecordType - a check search record type

Returns:

the check search record

Throws:

NullArgumentException - checkSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(checkSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.