public interface ActivitySearch extends OsidSearch
ActivitySearch
defines the interface for specifying
activity search options.
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongActivities(IdList activityIds)
activityIds
- list of activitiesNullArgumentException
- activityIds
is
null
mandatory
- This method must be implemented. void orderActivityResults(ActivitySearchOrder activitiesearchOrder)
activitiesearchOrder
- activity search orderNullArgumentException
- activitiesearchOrder
is null
UnsupportedException
- activitiesearchOrder
is not of this servicemandatory
- This method must be implemented. ActivitySearchRecord getActivitySearchRecord(Type activitiesearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.activitiesearchRecordType
- an activity search record typeNullArgumentException
-
activitiesearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasSearchRecordType(activitiesearchRecordType)
is
false
mandatory
- This method must be implemented.