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.DeedSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing deed searches. | ||
| Method | searchAmongDeeds | ||
| Description |
Execute this search among the given list of deeds. | ||
| Parameters | osid.id.IdList | DeedIds | list of deeds |
| Errors | NULL_ARGUMENT | DeedIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDeedResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.room.squatting.DeedSearchOrder | deedSearchOrder | a deed search order |
| Errors | NULL_ARGUMENT | deedSearchOrder is null | |
| UNSUPPORTED | deedSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeedSearchRecord | ||
| Description |
Gets the search record corresponding to the given deed
search record | ||
| Parameters | osid.type.Type | deedSearchRecordType | a deed search record type |
| Return | osid.room.squatting.records.DeedSearchRecord | the deed search record | |
| Errors | NULL_ARGUMENT | deedSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(deedSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |