public interface GradeEntrySearchSession extends GradeEntryQuerySession
This session provides methods for searching GradeEntry
objects. The search query is constructed using the GradeEntryQuery.
getGradeEntriesByQuery()
is the basic search method and
returns a list of GradeEntry
objects.A more advanced search
may be performed with getGradeEntriesBySearch().
It accepts
a GradeEntrySearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getGradeEntriesBySearch()
returns a
GradeEntrySearchResults
that can be used to access the resulting
GradeEntryList
or be used to perform a search within the
result set through GradeEntrySearch.
This session defines views that offer differing behaviors for searching.
Grade entries may have a query record indicated by their respective
record types. The query record is accessed via the GradeEntryQuery.
Modifier and Type | Method and Description |
---|---|
GradeEntrySearchResults |
getGradeEntriesBySearch(GradeEntryQuery gradeEntryQuery,
GradeEntrySearch gradeEntrySearch)
Gets the search results matching the given search query using the
given search.
|
GradeEntryQuery |
getGradeEntryQueryFromInspector(GradeEntryQueryInspector gradeEntryQueryInspector)
Gets a grade entry query from an inspector.
|
GradeEntrySearch |
getGradeEntrySearch()
Gets a grade entry search.
|
GradeEntrySearchOrder |
getGradeEntrySearchOrder()
Gets a grade entry search order.
|
canSearchGradeEntries, getGradebook, getGradebookId, getGradeEntriesByQuery, getGradeEntryQuery, useFederatedGradebookView, useIsolatedGradebookView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GradeEntrySearch getGradeEntrySearch()
mandatory
- This method must be implemented. GradeEntrySearchOrder getGradeEntrySearchOrder()
GradeEntrySearchOrder
is supplied to a GradeEntrySearch
to specify
the ordering of results.mandatory
- This method must be implemented. GradeEntrySearchResults getGradeEntriesBySearch(GradeEntryQuery gradeEntryQuery, GradeEntrySearch gradeEntrySearch) throws OperationFailedException, PermissionDeniedException
gradeEntryQuery
- the grade entry querygradeEntrySearch
- the grade entry searchNullArgumentException
- gradeEntryQuery
or gradeEntrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- gradeEntrySearch
or gradeEntryQuery
is not of this servicemandatory
- This method must be implemented. GradeEntryQuery getGradeEntryQueryFromInspector(GradeEntryQueryInspector gradeEntryQueryInspector)
GradeEntrySearchResults.
gradeEntryQueryInspector
- a grade entry query inspectorNullArgumentException
- gradeEntryQueryInspector
is null
UnsupportedException
- gradeEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.