org.osid.learning

Interface ActivitySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ActivitySearch
extends OsidSearch

ActivitySearch defines the interface for specifying activity search options.

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

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 activitiesearchOrder)

Specify an ordering to the search results.

Parameters:

activitiesearchOrder - activity search order

Throws:

NullArgumentException - activitiesearchOrder is null

UnsupportedException - activitiesearchOrder 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.