OSID - osid.resource.ResourceRelationshipSearchSession Service Interface Definition

Interface	osid.resource.ResourceRelationshipSearchSession
Implements	`osid.resource.ResourceRelationshipQuerySession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session provides methods for searching `ResourceRelationship` objects. The search query is constructed using the `ResourceRelationshipQuery`. The resource relationship record `Type` also specifies the record for the relationship query. `getResourceRelationshipsByQuery()` is the basic search method and returns a list of `ResourceRelationships`. A more advanced search may be performed with `getResourceRelationshipsBySearch()`. It accepts a `ResourceRelationshipSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getResourceRelationshipsBySearch()` returns an `ResourceRelationshipSearchResults` that can be used to access the resulting `ResourceRelationshipList` or be used to perform a search within the result set through `ResourceRelationshipSearch`. This session defines views that offer differing behaviors for searching. federated bin view: searches include relationships in bins of which this bin is an ancestor in the bin hierarchy isolated bin view: searches are restricted to relationships in this bin only Relationships may have a resource relationship query record indicated by their respective record types. The resource relationship query record is accessed via the `ResourceRelationshipQuery`.
Method	getResourceRelationshipSearch
Description	Gets a relationship search.
Return	`osid.resource.ResourceRelationshipSearch`		the relationship search
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipSearchOrder
Description	Gets a relationship search order. The `ResourceRelationshipSearchOrder` is supplied to a `ResourceRelationshipSearch` to specify the ordering of results.
Return	`osid.resource.ResourceRelationshipSearchOrder`		the relationship search order
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resource.ResourceRelationshipQuery`	`resourceRelationshipQuery`	the resource relationship query
Parameters	`osid.resource.ResourceRelationshipSearch`	`resourceRelationshipSearch`	the resource relationship search
Return	`osid.resource.ResourceRelationshipSearchResults`		the returned resource relationship search results
Errors	NULL_ARGUMENT		`resourceRelationshipQuery` or r `esourceRelationshipSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resourceRelationshipSearch` or r `esourceRelationshipQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipQueryFromInspector
Description	Gets a resource relationship query from an inspector. The inspector is available from a `ResourceRelationshipSearchResults`.
Parameters	`osid.resource.ResourceRelationshipQueryInspector`	`resourceRelationshipQueryInspector`	a query inspector
Return	`osid.resource.ResourceRelationshipQuery`		the resource relationship query
Errors	NULL_ARGUMENT		`resourceRelationshipQueryInspector` is `null`
Errors	UNSUPPORTED		`resourceRelationshipQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.