Interface | osid.room.squatting.LeaseSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing lease searches. | ||
Method | searchAmongLeases | ||
Description |
Execute this search among the given list of leases. | ||
Parameters | osid.id.IdList | leaseIds | list of leases |
Errors | NULL_ARGUMENT | leaseIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderLeaseResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.room.squatting.LeaseSearchOrder | leaseSearchOrder | lease search order |
Errors | NULL_ARGUMENT | leaseSearchOrder is null | |
UNSUPPORTED | leaseSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLeaseSearchRecord | ||
Description |
Gets the dis[atch search record corresponding to the
given lease search record | ||
Parameters | osid.type.Type | leaseSearchRecordType | a lease search record type |
Return | osid.room.squatting.records.LeaseSearchRecord | the lease search record | |
Errors | NULL_ARGUMENT | leaseSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(leaseSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |