OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
room squatting package
Version 3.0.0
Release Candidate Preview
| Interface | osid.room.squatting.LeaseSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getLeases | ||
| Description |
Gets the lease list resulting from a search. | ||
| Return | osid.room.squatting.LeaseList | the lease list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLeaseQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.room.squatting.LeaseQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLeaseSearchResultsRecord | ||
| 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. | ||
| Parameters | osid.type.Type | leaseSearchRecordType | a lease search record type |
| Return | osid.room.squatting.records.LeaseSearchResultsRecord | the lease search results 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. | |