Interface | osid.room.squatting.DeedSearchSession | ||
---|---|---|---|
Implements | osid.room.squatting.DeedQuerySession | ||
Description |
This session provides methods for searching Deeds may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getDeedSearch | ||
Description |
Gets a deed search. | ||
Return | osid.room.squatting.DeedSearch | the deed search | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeedSearchOrder | ||
Description |
Gets a deed search order. The | ||
Return | osid.room.squatting.DeedSearchOrder | the deed search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeedsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.room.squatting.DeedQuery | deedQuery | the deed query |
osid.room.squatting.DeedSearch | deedSearch | the deed search | |
Return | osid.room.squatting.DeedSearchResults | the deed search results | |
Errors | NULL_ARGUMENT | deedQuery or deedSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | deedQuery or deedSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDeedQueryFromInspector | ||
Description |
Gets a deed query from an inspector. The inspector is
available from a | ||
Parameters | osid.room.squatting.DeedQueryInspector | deedQueryInspector | a query inspector |
Return | osid.room.squatting.DeedQuery | the deed query | |
Errors | NULL_ARGUMENT | deedQueryInspector is null | |
UNSUPPORTED | deedQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |