public interface ProficiencySearchSession extends ProficiencyQuerySession
This session provides methods for searching among Proficiency
objects. The search query is constructed using the
ProficiencyQuery.
getProficienciesByQuery()
is the basic search method
and returns a list of Proficiencies.
A more advanced search
may be performed with getProficienciesBySearch().
It
accepts a ProficiencySearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as ordering. getProficienciesBySearch()
returns a
ProficiencySearchResults
that can be used to access the
resulting ProficiencyList
or be used to perform a search
within the result set through ProficiencySearch.
This session defines views that offer differing behaviors for searching.
Proficiencies may have a query record indicated by their respective
record types. The query record is accessed via the
ProficiencyQuery.
Modifier and Type | Method and Description |
---|---|
ProficiencySearchResults |
getProficienciesBySearch(ProficiencyQuery proficiencyQuery,
ProficiencySearch proficiencySearch)
Gets the search results matching the given search query using the
given search.
|
ProficiencyQuery |
getProficiencyQueryFromInspector(ProficiencyQueryInspector proficiencyQueryInspector)
Gets a proficiency query from an inspector.
|
ProficiencySearch |
getProficiencySearch()
Gets a proficiency search.
|
ProficiencySearchOrder |
getProficiencySearchOrder()
Gets a proficiency search order.
|
canSearchProficiencies, getObjectiveBank, getObjectiveBankId, getProficienciesByQuery, getProficiencyQuery, useFederatedObjectiveBankView, useIsolatedObjectiveBankView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProficiencySearch getProficiencySearch()
mandatory
- This method must be implemented. ProficiencySearchOrder getProficiencySearchOrder()
ProficiencySearchOrder
is supplied to a ProficiencySearch
to specify
the ordering of results.mandatory
- This method must be implemented. ProficiencySearchResults getProficienciesBySearch(ProficiencyQuery proficiencyQuery, ProficiencySearch proficiencySearch) throws OperationFailedException, PermissionDeniedException
proficiencyQuery
- the proficiency queryproficiencySearch
- the proficiency searchNullArgumentException
- proficiencyQuery
or proficiencySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- proficiencyQuery
or proficiencySearch
is not of this servicemandatory
- This method must be implemented. ProficiencyQuery getProficiencyQueryFromInspector(ProficiencyQueryInspector proficiencyQueryInspector)
ProficiencySearchResults.
proficiencyQueryInspector
- a proficiency query inspectorNullArgumentException
-
proficiencyQueryInspector
is null
UnsupportedException
- proficiencyQueryInspector
is not of this servicemandatory
- This method must be implemented.