org.osid.room.squatting

Interface LeaseSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, LeaseQuerySession, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.room.squatting.LeaseQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.