Interface ActivityUnitSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ActivityUnitSearch
extends OsidSearch

The search interface for governing activity unit searches.

Method Summary

Modifier and Type	Method	Description
ActivityUnitSearchRecord	getActivityUnitSearchRecord(Type activityUnitSearchRecordType)	Gets the activity unit search record corresponding to the given activity unit search record Type .This method is used to retrieve an object implementing the requested record.
void	orderActivityUnitResults(ActivityUnitSearchOrder activityUnitSearchOrder)	Specify an ordering to the search results.
void	searchAmongActivityUnits(IdList activityUnitIds)	Execute this search among the given list of activity units.

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

searchAmongActivityUnits

void searchAmongActivityUnits(IdList activityUnitIds)

Execute this search among the given list of activity units.

Parameters:

activityUnitIds - list of activity units

Throws:

NullArgumentException - activityUnitIds is null

Compliance:

mandatory - This method must be implemented.

orderActivityUnitResults

void orderActivityUnitResults(ActivityUnitSearchOrder activityUnitSearchOrder)

Specify an ordering to the search results.

Parameters:

activityUnitSearchOrder - activity unit search order

Throws:

NullArgumentException - activityUnitSearchOrder is null

UnsupportedException - activityUnitSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getActivityUnitSearchRecord

ActivityUnitSearchRecord getActivityUnitSearchRecord(Type activityUnitSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

activityUnitSearchRecordType - an activity unit search record type

Returns:

the activity unit search record

Throws:

NullArgumentException - activityUnitSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityUnitSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.