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.DeedSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByBuilding | ||
| Description |
Specifies a preference for ordering the result set by the building. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsBuildingSearchOrder | ||
| Description |
Tests if a building search order is available. | ||
| Return | boolean | true if a building search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBuildingSearchOrder | ||
| Description |
Gets the building search order. | ||
| Return | osid.room.BuildingSearchOrder | the building search order | |
| Errors | UNIMPLEMENTED | supportsBuildingSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsBuildingSearchOrder()
is true. | |
| Method | orderByOwner | ||
| Description |
Specifies a preference for ordering the result set by the owner. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsOwnerSearchOrder | ||
| Description |
Tests if an owner resource search order is available. | ||
| Return | boolean | true if an owner search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOwnerSearchOrder | ||
| Description |
Gets the owner resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsOwnerSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsOwnerSearchOrder()
is true. | |
| Method | getDeedSearchOrderRecord | ||
| Description |
Gets the deed search order record corresponding to the given deed record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | deedRecordType | a deed record type |
| Return | osid.room.squatting.records.DeedSearchOrderRecord | the deed search order record | |
| Errors | NULL_ARGUMENT | deedRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(deedRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |