Interface LeaseSearchSession

All Superinterfaces:

AutoCloseable, Closeable, LeaseQuerySession, OsidSession, OsidSession

public interface LeaseSearchSession
extends LeaseQuerySession

This session provides methods for searching Leases. 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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface LeaseQuerySession

canSearchLeases, getCampus, getCampusId, getLeaseQuery, getLeasesByQuery, useFederatedCampusView, useIsolatedCampusView

Modifier and Type	Method	Description
boolean	canSearchLeases()	Tests if this user can perform Lease searches.
Campus	getCampus()	Gets the Campus associated with this session.
Id	getCampusId()	Gets the Campus Id associated with this session.
LeaseQuery	getLeaseQuery()	Gets a lease query.
LeaseList	getLeasesByQuery(LeaseQuery leaseQuery)	Gets a list of Leases matching the given lease query.
void	useFederatedCampusView()	Federates the view for methods in this session.
void	useIsolatedCampusView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getLeaseSearch

LeaseSearch getLeaseSearch()

Gets a lease search.

Returns:

the lease search

Compliance:

mandatory - This method must be implemented.

getLeaseSearchOrder

LeaseSearchOrder getLeaseSearchOrder()

Gets a lease search order. The LeaseSearchOrder is supplied to a LeaseSearch to specify the ordering of results.

Returns:

the lease search order

Compliance:

mandatory - This method must be implemented.

getLeasesBySearch

LeaseSearchResults getLeasesBySearch(LeaseQuery leaseQuery,
 LeaseSearch leaseSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

leaseQuery - the lease query

leaseSearch - the lease search

Returns:

the lease search results

Throws:

NullArgumentException - leaseQuery or leaseSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - leaseQuery or leaseSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getLeaseQueryFromInspector

LeaseQuery getLeaseQueryFromInspector(LeaseQueryInspector leaseQueryInspector)

Gets an entry query from an inspector. The inspector is available from an LeaseSearchResults.

Parameters:

leaseQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - leaseQueryInspector is null

UnsupportedException - leaseQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.