public interface ActivityBundleSearch extends OsidSearch
The search interface for governing activity bundle searches.
Modifier and Type | Method and Description |
---|---|
ActivityBundleSearchRecord |
getActivityBundleSearchRecord(Type activityBundleSearchRecordType)
Gets the activity bundle search record corresponding to the given
activity bundle search record
Type. |
void |
orderActivityBundleResults(ActivityBundleSearchOrder activityBundleSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongActivityBundles(IdList activityBundleIds)
Execute this search among the given list of activity bundles.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongActivityBundles(IdList activityBundleIds)
activityBundleIds
- list of activity bundlesNullArgumentException
- activityBundleIds
is null
mandatory
- This method must be implemented. void orderActivityBundleResults(ActivityBundleSearchOrder activityBundleSearchOrder)
activityBundleSearchOrder
- activity bundle search orderNullArgumentException
-
activityBundleSearchOrder
is null
UnsupportedException
- activityBundleSearchOrder
is not of this servicemandatory
- This method must be implemented. ActivityBundleSearchRecord getActivityBundleSearchRecord(Type activityBundleSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.activityBundleSearchRecordType
- a activity bundle search record
typeNullArgumentException
-
activityBundleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityBundleSearchRecordType)
is
false
mandatory
- This method must be implemented.