OSID - osid.room.squatting.DeedSearchSession Service Interface Definition

Interface	osid.room.squatting.DeedSearchSession
Implements	`osid.room.squatting.DeedQuerySession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	This session provides methods for searching `Deeds` . The search query is constructed using the `DeedQuery` . The deed record `Type` also specifies the record for the deed query. `getDeedsByQuery()` is the basic search method and returns a list of `Deed` elements. A more advanced search may be performed with `getDeedsBySearch()` . It accepts a `DeedSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDeedsBySearch()` returns a `DeedSearchResults` that can be used to access the resulting `DeedList` or be used to perform a search within the result set through `DeedSearch` . Deeds may have a query record indicated by their respective record types. The query record is accessed via the `DeedQuery` . The returns in this session may not be cast directly to these interfaces.
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 `DeedSearchOrder` is supplied to a `DeedSearch` to specify the ordering of results.
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
Parameters	`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 `DeedSearchResults` .
Parameters	`osid.room.squatting.DeedQueryInspector`	`deedQueryInspector`	a query inspector
Return	`osid.room.squatting.DeedQuery`		the deed query
Errors	NULL_ARGUMENT		`deedQueryInspector` is `null`
Errors	UNSUPPORTED		`deedQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.