public interface ActivityBundleSearchSession extends ActivityBundleQuerySession
This session provides methods for searching among ActivityBundle
objects. The search query is constructed using the
ActivityBundleQuery.
getActivityBundlesByQuery()
is the basic search method
and returns a list of ActivityBundles.
A more advanced
search may be performed with getActivityBundlesBySearch().
It accepts an ActivityBundleSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as ordering. getActivityBundlesBySearch()
returns an ActivityBundleSearchResults
that can be used to
access the resulting ActivityBundleList
or be used to
perform a search within the result set through
ActivityBundleSearch.
This session defines views that offer differing behaviors for searching.
Activity Bundles may have a query record indicated by their respective
record types. The query record is accessed via the
ActivityBundleQuery.
Modifier and Type | Method and Description |
---|---|
ActivityBundleQuery |
getActivityBundleQueryFromInspector(ItemQueryInspector activityBundleQueryInspector)
Gets an activity bundle query from an inspector.
|
ActivityBundleSearchResults |
getActivityBundlesBySearch(ActivityBundleQuery activityBundleQuery,
ActivityBundleSearch activityBundleSearch)
Gets the search results matching the given search query using the
given search.
|
ActivityBundleSearch |
getActivityBundleSearch()
Gets an activity bundle search.
|
ActivityBundleSearchOrder |
getActivityBundleSearchOrder()
Gets an activity search order.
|
canSearchActivityBundles, getActivityBundleQuery, getActivityBundlesByQuery, getCourseCatalog, getCourseCatalogId, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ActivityBundleSearch getActivityBundleSearch()
mandatory
- This method must be implemented. ActivityBundleSearchOrder getActivityBundleSearchOrder()
ActivityBundleSearchOrder
is supplied to an ActivityBundleSearch
to
specify the ordering of results.mandatory
- This method must be implemented. ActivityBundleSearchResults getActivityBundlesBySearch(ActivityBundleQuery activityBundleQuery, ActivityBundleSearch activityBundleSearch) throws OperationFailedException, PermissionDeniedException
activityBundleQuery
- the activity bundle queryactivityBundleSearch
- the activity bundle searchNullArgumentException
- activityBundleQuery
or activityBundleSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- activityBundleQuery
or activityBundleSearch
is not of this
servicemandatory
- This method must be implemented. ActivityBundleQuery getActivityBundleQueryFromInspector(ItemQueryInspector activityBundleQueryInspector)
ActivityBundleSearchResults.
activityBundleQueryInspector
- a query inspectorNullArgumentException
-
activityBundleQueryInspector
is null
UnsupportedException
-
activityBundleQueryInspector
is not of this servicemandatory
- This method must be implemented.