public interface LeaseSearchSession extends LeaseQuerySession
This session provides methods for searching Lease
objects. The search query is constructed using the LeaseQuery.
The lease record Type
also specifies the record for
the lease query.
getLeasesByQuery()
is the basic search method and
returns a list of Lease
elements. A more advanced search
may be performed with getLeasesBySearch().
It accepts a
LeaseSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getLeaseeBySearch()
returns a
LeaseSearchResults
that can be used to access the resulting
LeaseList
or be used to perform a search within the result set
through LeaseSearch.
Leases may have a query record indicated by their respective record
types. The query record is accessed via the LeaseQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
LeaseQuery |
getLeaseQueryFromInspector(LeaseQueryInspector leaseQueryInspector)
Gets an entry query from an inspector.
|
LeaseSearchResults |
getLeasesBySearch(LeaseQuery leaseQuery,
LeaseSearch leaseSearch)
Gets the search results matching the given search.
|
LeaseSearch |
getLeaseSearch()
Gets a lease search.
|
LeaseSearchOrder |
getLeaseSearchOrder()
Gets a lease search order.
|
canSearchLeases, getCampus, getCampusId, getLeaseQuery, getLeasesByQuery, useFederatedCampusView, useIsolatedCampusView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
LeaseSearch getLeaseSearch()
mandatory
- This method must be implemented. LeaseSearchOrder getLeaseSearchOrder()
LeaseSearchOrder
is
supplied to a LeaseSearch
to specify the ordering of
results.mandatory
- This method must be implemented. LeaseSearchResults getLeasesBySearch(LeaseQuery leaseQuery, LeaseSearch leaseSearch) throws OperationFailedException, PermissionDeniedException
leaseQuery
- the lease queryleaseSearch
- the lease searchNullArgumentException
- leaseQuery
or
leaseSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- leaseQuery
or
leaseSearch
is not of this servicemandatory
- This method must be implemented. LeaseQuery getLeaseQueryFromInspector(LeaseQueryInspector leaseQueryInspector)
LeaseSearchResults.
leaseQueryInspector
- a query inspectorNullArgumentException
- leaseQueryInspector
is null
UnsupportedException
- leaseQueryInspector
is not of this servicemandatory
- This method must be implemented.