OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.SearchProxyManager
Implementsosid.OsidProxyManager
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.

MethodgetSearchSession
Description

Gets the OsidSession associated with the search service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.search.SearchSessiona SearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSearch() is false
ComplianceoptionalThis method must be implemented if supportsSearch() is true.
MethodgetSearchSessionForEngine
Description

Gets the OsidSession associated with the search service for the given engine.

Parametersosid.id.IdengineIdthe Id of an engine
osid.proxy.Proxyproxythe proxy
Returnosid.search.SearchSessiona SearchSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSearch() and supportsVisibleFederation() are true
MethodgetEngineLookupSession
Description

Gets the OsidSession associated with the engine lookup service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.search.EngineLookupSessionan EngineLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineLookup() is false
ComplianceoptionalThis method must be implemented if supportsEngineLookup() is true.
MethodgetEngineQuerySession
Description

Gets the OsidSession associated with the engine query service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.search.EngineQuerySessionan EngineQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineQuery() is false
ComplianceoptionalThis method must be implemented if supportsEngineQuery() is true.
MethodgetEngineSearchSession
Description

Gets the OsidSession associated with the engine search service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.search.EngineSearchSessionan EngineSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineSearch() is false
ComplianceoptionalThis method must be implemented if supportsEngineSearch() is true.
MethodgetEngineAdminSession
Description

Gets the OsidSession associated with the engine administrative service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.search.EngineAdminSessionan EngineAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEngineAdmin() is true.
MethodgetEngineNotificationSession
Description

Gets the OsidSession associated with the engine notification service.

Parametersosid.search.EngineReceiverengineReceiverthe receiver
osid.proxy.Proxyproxythe proxy
Returnosid.search.EngineNotificationSessionan EngineNotificationSession
ErrorsNULL_ARGUMENT engineReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineNotification() is false
ComplianceoptionalThis method must be implemented if supportsEngineNotification() is true.
MethodgetEngineHierarchySession
Description

Gets the OsidSession associated with the engine hierarchy service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.search.EngineHierarchySessionan EngineHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsEngineHierarchy() is true.
MethodgetEngineHierarchyDesignSession
Description

Gets the OsidSession associated with the engine hierarchy design service.

Parametersosid.proxy.Proxyproxythe proxy
Returnosid.search.EngineHierarchyDesignSessionan EngineHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEngineHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsEngineHierarchyDesign() is true.