public interface OfferingSearchSession extends OfferingQuerySession
This session provides methods for searching Offering
objects. The search query is constructed using the OfferingQuery.
The offering record Type
also specifies the record
for the offering query.
getOfferingsByQuery()
is the basic search method and
returns a list of Offering
elements. A more advanced search
may be performed with getOfferingsBySearch().
It accepts an
OfferingSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getOfferingsBySearch()
returns an
OfferingSearchResults
that can be used to access the resulting
OfferingList
or be used to perform a search within the
result set through OfferingSearch.
This session defines views that offer differing behaviors for searching.
Offerings may have a query record indicated by their respective record
types. The query record is accessed via the OfferingQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
OfferingQuery |
getOfferingQueryFromInspector(OfferingQueryInspector offeringQueryInspector)
Gets an offering query from an inspector.
|
OfferingSearchResults |
getOfferingsBySearch(OfferingQuery offeringQuery,
OfferingSearch offeringSearch)
Gets the search results matching the given search.
|
OfferingSearch |
getOfferingSearch()
Gets an offering search.
|
OfferingSearchOrder |
getOfferingSearchOrder()
Gets an offering search order.
|
canSearchOfferings, getCatalogue, getCatalogueId, getOfferingQuery, getOfferingsByQuery, useFederatedCatalogueView, useIsolatedCatalogueView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OfferingSearch getOfferingSearch()
mandatory
- This method must be implemented. OfferingSearchOrder getOfferingSearchOrder()
OfferingSearchOrder
is supplied to an OfferingSearch
to specify the
ordering of results.mandatory
- This method must be implemented. OfferingSearchResults getOfferingsBySearch(OfferingQuery offeringQuery, OfferingSearch offeringSearch) throws OperationFailedException, PermissionDeniedException
offeringQuery
- the offering queryofferingSearch
- the offering searchNullArgumentException
- offeringQuery
or
offeringSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- offeringQuery
or
offeringSearch
is not of this servicemandatory
- This method must be implemented. OfferingQuery getOfferingQueryFromInspector(OfferingQueryInspector offeringQueryInspector)
OfferingSearchResults.
offeringQueryInspector
- an offering query inspectorNullArgumentException
- offeringQueryInspector
is null
UnsupportedException
- offeringQueryInspector
is not of this servicemandatory
- This method must be implemented.