OSID - osid.search.SearchProxyManager Service Interface Definition

Interface	osid.search.SearchProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.search.SearchProfile`
Description	The search manager provides access to search sessions and provides interoperability tests for various aspects of this service. These methods accept a `Proxy` interface. The sessions included in this manager are: `SearchSession:` a session for evaluating and executing search `EngineLookupSession:` a session to retrieve engine objects `EngineQuerySession:` a session to query for engines `EngineSearchSession:` a session to search for engines `EngineAdminSession:` a session to create, update and delete engines `EngineNotificationSession:` a session to receive notifications for changes in engines `EngineHierarchySession:` a session to traverse hierarchies of engines `EngineHierarchyDesignSession:` a session to manage hierarchies of engines The search manager also provides a profile for determing the supported search types supported by this service.
Method	getSearchSession
Description	Gets the `OsidSession` associated with the search service.
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.SearchSession`		a `SearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSearch()` is `true.`
Method	getSearchSessionForEngine
Description	Gets the `OsidSession` associated with the search service for the given engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.SearchSession`		a `SearchSession`
Errors	NOT_FOUND		no `Engine` found by the given `Id`
	NULL_ARGUMENT		`engineId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSearch()` and `supportsVisibleFederation()` are `true`
Method	getEngineLookupSession
Description	Gets the `OsidSession` associated with the engine lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.EngineLookupSession`		an `EngineLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEngineLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineLookup()` is `true.`
Method	getEngineQuerySession
Description	Gets the `OsidSession` associated with the engine query service.
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.EngineQuerySession`		an `EngineQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEngineQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineQuery()` is `true.`
Method	getEngineSearchSession
Description	Gets the `OsidSession` associated with the engine search service.
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.EngineSearchSession`		an `EngineSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEngineSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineSearch()` is `true.`
Method	getEngineAdminSession
Description	Gets the `OsidSession` associated with the engine administrative service.
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.EngineAdminSession`		an `EngineAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEngineAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineAdmin()` is `true.`
Method	getEngineNotificationSession
Description	Gets the `OsidSession` associated with the engine notification service.
Parameters	`osid.search.EngineReceiver`	`engineReceiver`	the receiver
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.EngineNotificationSession`		an `EngineNotificationSession`
Errors	NULL_ARGUMENT		`engineReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEngineNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineNotification()` is `true.`
Method	getEngineHierarchySession
Description	Gets the `OsidSession` associated with the engine hierarchy service.
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.EngineHierarchySession`		an `EngineHierarchySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEngineHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineHierarchy()` is `true.`
Method	getEngineHierarchyDesignSession
Description	Gets the `OsidSession` associated with the engine hierarchy design service.
Parameters	`osid.proxy.Proxy`	`proxy`	the proxy
Return	`osid.search.EngineHierarchyDesignSession`		an `EngineHierarchyDesignSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEngineHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEngineHierarchyDesign()` is `true.`