Interface ActivitySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ActivitySearch
extends OsidSearch

ActivitySearch defines the interface for specifying activity search options.

Method Summary

Modifier and Type	Method	Description
ActivitySearchRecord	getActivitySearchRecord(Type activitiesearchRecordType)	Gets the activity record corresponding to the given activity search record Type.
void	orderActivityResults(ActivitySearchOrder activitySearchOrder)	Specify an ordering to the search results.
void	searchAmongActivities(IdList activityIds)	Execute this search among the given list of activities.

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

searchAmongActivities

void searchAmongActivities(IdList activityIds)

Execute this search among the given list of activities.

Parameters:

activityIds - list of activities

Throws:

NullArgumentException - activityIds is null

Compliance:

mandatory - This method must be implemented.

orderActivityResults

void orderActivityResults(ActivitySearchOrder activitySearchOrder)

Specify an ordering to the search results.

Parameters:

activitySearchOrder - activity search order

Throws:

NullArgumentException - activitySearchOrder is null

UnsupportedException - activitySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getActivitySearchRecord

ActivitySearchRecord getActivitySearchRecord(Type activitiesearchRecordType)
                                      throws OperationFailedException

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

Parameters:

activitiesearchRecordType - an activity search record type

Returns:

the activity search record

Throws:

NullArgumentException - activitiesearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasSearchRecordType(activitiesearchRecordType) is false

Compliance:

mandatory - This method must be implemented.