OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.LeaseSearchResults
Implementsosid.OsidSearchResults
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.LeaseListthe lease list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetLeaseQueryInspector
Description

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

Returnosid.room.squatting.LeaseQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypeleaseSearchRecordTypea lease search record type
Returnosid.room.squatting.records.LeaseSearchResultsRecordthe lease search results record
ErrorsNULL_ARGUMENT LeaseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(leaseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.