OSID Logo
OSID Specifications
room squatting package
Version 3.1.0
Interfaceosid.room.squatting.LeaseSearch
Implementsosid.OsidSearch
Used Byosid.room.squatting.LeaseSearchSession
Description

The search interface for governing lease searches.

MethodsearchAmongLeases
Description

Execute this search among the given list of leases.

Parametersosid.id.IdListleaseIds list of leases
ErrorsNULL_ARGUMENT leaseIds is null
Compliancemandatory This method must be implemented.
MethodorderLeaseResults
Description

Specify an ordering to the search results.

Parametersosid.room.squatting.LeaseSearchOrderleaseSearchOrder lease search order
ErrorsNULL_ARGUMENT leaseSearchOrder is null
UNSUPPORTED leaseSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetLeaseSearchRecord
Description

Gets the dis[atch search 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.LeaseSearchRecord the lease search record
ErrorsNULL_ARGUMENT leaseSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(leaseSearchRecordType) is false
Compliancemandatory This method must be implemented.