public interface AwardSearchSession extends AwardQuerySession
This session provides methods for searching Award
objects. The search query is constructed using the AwardQuery.
The award record Type
also specifies the record for
the award query.
getAwardsByQuery()
is the basic search method and
returns a list of Award
elements. A more advanced search
may be performed with getAwardsBySearch().
It accepts an
AwardSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getAwardsBySearch()
returns an
AwardSearchResults
that can be used to access the resulting
AwardList
or be used to perform a search within the result set
through AwardSearch.
Awards may have a query record indicated by their respective record
types. The query record is accessed via the AwardQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
AwardQuery |
getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector)
Gets an award query from an inspector.
|
AwardSearchResults |
getAwardsBySearch(AwardQuery awardQuery,
AwardSearch awardSearch)
Gets the search results matching the given search.
|
AwardSearch |
getAwardSearch()
Gets an award search.
|
AwardSearchOrder |
getAwardSearchOrder()
Gets an award search order.
|
canSearchAwards, getAcademy, getAcademyId, getAwardQuery, getAwardsByQuery, useFederatedAcademyView, useIsolatedAcademyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AwardSearch getAwardSearch()
mandatory
- This method must be implemented. AwardSearchOrder getAwardSearchOrder()
AwardSearchOrder
is
supplied to an AwardSearch
to specify the ordering of
results.mandatory
- This method must be implemented. AwardSearchResults getAwardsBySearch(AwardQuery awardQuery, AwardSearch awardSearch) throws OperationFailedException, PermissionDeniedException
awardQuery
- the award queryawardSearch
- the award searchNullArgumentException
- awardQuery
or
awardSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- awardQuery
or
awardSearch
is not of this servicemandatory
- This method must be implemented. AwardQuery getAwardQueryFromInspector(AwardQueryInspector awardQueryInspector)
AwardSearchResults.
awardQueryInspector
- an award query inspectorNullArgumentException
- awardQueryInspector
is null
UnsupportedException
- awardQueryInspector
is not of this servicemandatory
- This method must be implemented.