public interface CredentialEntrySearchSession extends CredentialEntryQuerySession
This session provides methods for searching among
CredentialEntries.
The search query is constructed using the
CredentialEntryQuery.
getCredentialEntriesByQuery()
is the basic search
method and returns a list of CredentialEntries.
A more
advanced search may be performed with
getCredentialEntriesBySearch().
It accepts a
CredentialEntrySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getCredentialEntriesBySearch()
returns a
CredentialEntrySearchResults
that can be used to access the
resulting CredentialEntryList
or be used to perform a
search within the result set through CredentialEntrySearch.
This session defines views that offer differing behaviors for searching.
CredentialEntries may have a query record indicated by their
respective record types. The query record is accessed via the
CredentialEntryQuery.
Modifier and Type | Method and Description |
---|---|
CredentialEntrySearchResults |
getCredentialEntriesBySearch(CredentialEntryQuery credentialEntryQuery,
CredentialEntrySearch credentialEntrySearch)
Gets the search results matching the given search query using the
given search.
|
CredentialEntryQuery |
getCredentialEntryQueryFromInspector(CredentialEntryQueryInspector credentialEntryQueryInspector)
Gets a credential entry query from an inspector.
|
CredentialEntrySearch |
getCredentialEntrySearch()
Gets a credential entry search.
|
CredentialEntrySearchOrder |
getCredentialEntrySearchOrder()
Gets a credential entry search order.
|
canSearchCredentialEntries, getCourseCatalog, getCourseCatalogId, getCredentialEntriesByQuery, getCredentialEntryQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CredentialEntrySearch getCredentialEntrySearch()
mandatory
- This method must be implemented. CredentialEntrySearchOrder getCredentialEntrySearchOrder()
CredentialEntrySearchOrder
is supplied to a
CredentialEntrySearch
to specify the ordering of results.mandatory
- This method must be implemented. CredentialEntrySearchResults getCredentialEntriesBySearch(CredentialEntryQuery credentialEntryQuery, CredentialEntrySearch credentialEntrySearch) throws OperationFailedException, PermissionDeniedException
credentialEntryQuery
- the credential entry querycredentialEntrySearch
- the credential entry searchNullArgumentException
- credentialEntryQuery
or credentialEntrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- credentialEntryQuery
or CredentialEntrySearch
is not of this
servicemandatory
- This method must be implemented. CredentialEntryQuery getCredentialEntryQueryFromInspector(CredentialEntryQueryInspector credentialEntryQueryInspector)
CredentialEntrySearchResults.
credentialEntryQueryInspector
- a credential entry query
inspectorNullArgumentException
-
credentialEntryQueryInspector
is null
UnsupportedException
-
credentialEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.