OSID Logo
OSID Specifications
room squatting package
Version 3.1.0
Interfaceosid.room.squatting.LeaseSearchResults
Implementsosid.OsidSearchResults
Used Byosid.room.squatting.LeaseSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetLeases
Description

Gets the lease list resulting from a search.

Returnosid.room.squatting.LeaseList the lease list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetLeaseQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.room.squatting.LeaseQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetLeaseSearchResultsRecord
Description

Gets the lease search results record corresponding to the given lease search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeleaseSearchRecordType a lease search record type
Returnosid.room.squatting.records.LeaseSearchResultsRecord the lease search results record
ErrorsNULL_ARGUMENT LeaseSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(leaseSearchRecordType) is false
Compliancemandatory This method must be implemented.