public interface GradeSystemSearchSession extends GradeSystemQuerySession
This session provides methods for searching among GradeSystems.
The search query is constructed using the GradeSystemQuery.
getGradeSystemsByQuery()
is the basic search method and
returns a list of GradeSystems.
A more advanced search may
be performed with getGradeSystemsBySearch().
It accepts a
GradeSystemSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getGradeSystemsBySearch()
returns a
GradeSystemSearchResults
that can be used to access the resulting
GradeSystemList
or be used to perform a search within the
result set through GradeSystemSearch.
This session defines views that offer differing behaviors for searching.
Grade systems may have a query record indicated by their respective
record types. The query record is accessed via the
GradeSystemQuery.
Modifier and Type | Method and Description |
---|---|
GradeSystemQuery |
getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector)
Gets a grade system query from an inspector.
|
GradeSystemSearchResults |
getGradeSystemsBySearch(GradeSystemQuery gradeSystemQuery,
GradeSystemSearch gradeSystemSearch)
Gets the search results matching the given search query using the
given search.
|
GradeSystemSearch |
getGradeSystemSearch()
Gets a grade system search.
|
GradeSystemSearchOrder |
getGradeSystemSearchOrder()
Gets a grade system search order.
|
canSearchGradeSystems, getGradebook, getGradebookId, getGradeSystemQuery, getGradeSystemsByQuery, useFederatedGradebookView, useIsolatedGradebookView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GradeSystemSearch getGradeSystemSearch()
mandatory
- This method must be implemented. GradeSystemSearchOrder getGradeSystemSearchOrder()
GradeSystemSearchOrder
is supplied to a GradeSystemSearch
to specify
the ordering of results.mandatory
- This method must be implemented. GradeSystemSearchResults getGradeSystemsBySearch(GradeSystemQuery gradeSystemQuery, GradeSystemSearch gradeSystemSearch) throws OperationFailedException, PermissionDeniedException
gradeSystemQuery
- the grade system querygradeSystemSearch
- the grade system searchNullArgumentException
- gradeSystemQuery
or gradeSystemSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- gradeSystemQuery
or gradeSystemSearch
is not of this servicemandatory
- This method must be implemented. GradeSystemQuery getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector)
GradeSystemSearchResults.
gradeSystemQueryInspector
- a grade system query inspectorNullArgumentException
-
gradeSystemQueryInspector
is null
UnsupportedException
- gradeSystemQueryInspector
is not of this servicemandatory
- This method must be implemented.