OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.LeaseSearch
Implementsosid.OsidSearch
Description

The search interface for governing lease searches.

MethodsearchAmongLeases
Description

Execute this search among the given list of leases.

Parametersosid.id.IdListleaseIdslist of leases
ErrorsNULL_ARGUMENT leaseIds is null
CompliancemandatoryThis method must be implemented.
MethodorderLeaseResults
Description

Specify an ordering to the search results.

Parametersosid.room.squatting.LeaseSearchOrderleaseSearchOrderlease search order
ErrorsNULL_ARGUMENT leaseSearchOrder is null
UNSUPPORTED leaseSearchOrder is not of this service
CompliancemandatoryThis 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.TypeleaseSearchRecordTypea lease search record type
Returnosid.room.squatting.records.LeaseSearchRecordthe lease search record
ErrorsNULL_ARGUMENT leaseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(leaseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.