public interface ActivitySearchSession extends ActivityQuerySession
This session provides methods for searching among Activity
objects. The search query is constructed using the
ActivityQuery.
getActivitiesByQuery()
is the basic search method and
returns a list of Activitys.
A more advanced search may be
performed with getActivitysBySearch().
It accepts an
ActivitySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getActivitiesBySearch()
returns an
ActivitySearchResults
that can be used to access the resulting
ActivityList
or be used to perform a search within the
result set through ActivitySearch.
This session defines views that offer differing behaviors for searching.
Activities may have a query record indicated by their respective
record types. The query record is accessed via the ActivityQuery.
Modifier and Type | Method and Description |
---|---|
ActivitySearchResults |
getActivitiesBySearch(ActivityQuery activityQuery,
ActivitySearch activitySearch)
Gets the search results matching the given search query using the
given search.
|
ActivityQuery |
getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)
Gets an activity query from an inspector.
|
ActivitySearch |
getActivitySearch()
Gets an activity search.
|
ActivitySearchOrder |
getActivitySearchOrder()
Gets an activity search order.
|
canSearchActivities, getActivitiesByQuery, getActivityQuery, getCourseCatalog, getCourseCatalogId, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ActivitySearch getActivitySearch()
mandatory
- This method must be implemented. ActivitySearchOrder getActivitySearchOrder()
ActivitySearchOrder
is supplied to an ActivitySearch
to specify the
ordering of results.mandatory
- This method must be implemented. ActivitySearchResults getActivitiesBySearch(ActivityQuery activityQuery, ActivitySearch activitySearch) throws OperationFailedException, PermissionDeniedException
activityQuery
- the activity queryactivitySearch
- the activity searchNullArgumentException
- activityQuery
or
activitySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- activityQuery
or
activitySearch
is not of this servicemandatory
- This method must be implemented. ActivityQuery getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)
ActivitySearchResults.
activityQueryInspector
- an activity query inspectorNullArgumentException
- activityQueryInspector
is null
UnsupportedException
- activityQueryInspector
is not of this servicemandatory
- This method must be implemented.