OSID - osid.relationship.rules.RelationshipEnablerSearchSession Service Interface Definition

Interface	osid.relationship.rules.RelationshipEnablerSearchSession
Implements	`osid.relationship.rules.RelationshipEnablerQuerySession`
Used By	`osid.relationship.rules.RelationshipRulesManager`
Used By	`osid.relationship.rules.RelationshipRulesProxyManager`
Description	This session provides methods for searching among `RelationshipEnabler` objects. The search query is constructed using the `RelationshipEnableryQuery` . `getRelationshipEnablersByQuery()` is the basic search method and returns a list of `RelationshipEnablers` . A more advanced search may be performed with `getRelationshipEnablersBySearch()` . It accepts a `RelationshipEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRelationshipEnablersBySearch()` returns a `RelationshipEnablerSearchResults` that can be used to access the resulting `RelationshipEnablerList` or be used to perform a search within the result set through `RelationshipEnablerSearch` . This session defines views that offer differing behaviors for searching. federated relationship view: searches include relationship enablers in relationships of which this relationship is an ancestor in the relationship hierarchy isolated relationship view: searches are restricted to relationship enablers in this relationship `RelationshipEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `RelationshipEnablerQuery` .
Method	getRelationshipEnablerSearch
Description	Gets a relationship enabler search.
Return	`osid.relationship.rules.RelationshipEnablerSearch`		the relationship enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerSearchOrder
Description	Gets a relationship enabler search order. The `RelationshipEnablerSearchOrder` is supplied to a `RelationshipEnablerSearch` to specify the ordering of results.
Return	`osid.relationship.rules.RelationshipEnablerSearchOrder`		the relationship enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.relationship.rules.RelationshipEnablerQuery`	`relationshipEnablerQuery`	the relationship enabler query
Parameters	`osid.relationship.rules.RelationshipEnablerSearch`	`relationshipEnablerSearch`	the relationship enabler search
Return	`osid.relationship.rules.RelationshipEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`relationshipEnablerQuery` or `relationshipEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relationshipEnablerQuery` or `relationshipEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerQueryFromInspector
Description	Gets a relationship enabler query from an inspector. The inspector is available from a `RelationshipEnablerSearchResults` .
Parameters	`osid.relationship.rules.RelationshipEnablerQueryInspector`	`relationshipEnablerQueryInspector`	a relationship enabler query inspector
Return	`osid.relationship.rules.RelationshipEnablerQuery`		the relationship enabler query
Errors	NULL_ARGUMENT		`relationshipEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`relationshipEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.