OSID - osid.room.squatting.LeaseSearchSession Service Interface Definition

Interface	osid.room.squatting.LeaseSearchSession
Implements	`osid.room.squatting.LeaseQuerySession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	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	getLeaseSearch
Description	Gets a lease search.
Return	`osid.room.squatting.LeaseSearch`		the lease search
Compliance	`mandatory`		This method must be implemented.
Method	getLeaseSearchOrder
Description	Gets a lease search order. The `LeaseSearchOrder` is supplied to a `LeaseSearch` to specify the ordering of results.
Return	`osid.room.squatting.LeaseSearchOrder`		the lease search order
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.room.squatting.LeaseQuery`	`leaseQuery`	the lease query
Parameters	`osid.room.squatting.LeaseSearch`	`leaseSearch`	the lease search
Return	`osid.room.squatting.LeaseSearchResults`		the lease search results
Errors	NULL_ARGUMENT		`leaseQuery` or `leaseSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`leaseQuery` or `leaseSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getLeaseQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `LeaseSearchResults`.
Parameters	`osid.room.squatting.LeaseQueryInspector`	`leaseQueryInspector`	a query inspector
Return	`osid.room.squatting.LeaseQuery`		the entry query
Errors	NULL_ARGUMENT		`leaseQueryInspector` is `null`
Errors	UNSUPPORTED		`leaseQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.