Interface RegistrationTargetSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RegistrationTargetSearch
extends OsidSearch

The search interface for governing registration target searches.

Method Summary

Modifier and Type	Method	Description
RegistrationTargetSearchRecord	getRegistrationTargetSearchRecord(Type registrationTargetSearchRecordType)	Gets the registration target search record corresponding to the given registration target search record Type.
void	orderRegistrationTargetResults(RegistrationTargetSearchOrder registrationTargetSearchOrder)	Specify an ordering to the search results.
void	searchAmongRegistrationTargets(IdList registrationTargetIds)	Execute this search among the given list of registration targets.

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

searchAmongRegistrationTargets

void searchAmongRegistrationTargets(IdList registrationTargetIds)

Execute this search among the given list of registration targets.

Parameters:

registrationTargetIds - list of registration targets

Throws:

NullArgumentException - registrationTargetIds is null

Compliance:

mandatory - This method must be implemented.

orderRegistrationTargetResults

void orderRegistrationTargetResults(RegistrationTargetSearchOrder registrationTargetSearchOrder)

Specify an ordering to the search results.

Parameters:

registrationTargetSearchOrder - registration target search order

Throws:

NullArgumentException - registrationTargetSearchOrder is null

UnsupportedException - registrationTargetSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRegistrationTargetSearchRecord

RegistrationTargetSearchRecord getRegistrationTargetSearchRecord(Type registrationTargetSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

registrationTargetSearchRecordType - a registration target search record type

Returns:

the registration target search record

Throws:

NullArgumentException - registrationTargetSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationTargetSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.