org.osid.search

Interface SearchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, SearchProfile, Sourceable

public interface SearchProxyManager
extends OsidProxyManager, SearchProfile

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 Summary

Methods

Modifier and Type	Method and Description
EngineAdminSession	getEngineAdminSession(Proxy proxy) Gets the OsidSession associated with the engine administrative service.
EngineHierarchyDesignSession	getEngineHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the engine hierarchy design service.
EngineHierarchySession	getEngineHierarchySession(Proxy proxy) Gets the OsidSession associated with the engine hierarchy service.
EngineLookupSession	getEngineLookupSession(Proxy proxy) Gets the OsidSession associated with the engine lookup service.
EngineNotificationSession	getEngineNotificationSession(EngineReceiver engineReceiver, Proxy proxy) Gets the OsidSession associated with the engine notification service.
EngineQuerySession	getEngineQuerySession(Proxy proxy) Gets the OsidSession associated with the engine query service.
EngineSearchSession	getEngineSearchSession(Proxy proxy) Gets the OsidSession associated with the engine search service.
SearchSession	getSearchSession(Proxy proxy) Gets the OsidSession associated with the search service.
SearchSession	getSearchSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the search service for the given engine.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.search.SearchProfile

getEngineRecordTypes, getEngineSearchRecordTypes, getQueryRecordTypes, getSearchRecordTypes, supportsEngineAdmin, supportsEngineHierarchy, supportsEngineHierarchyDesign, supportsEngineLookup, supportsEngineNotification, supportsEngineQuery, supportsEngineRecordType, supportsEngineSearch, supportsEngineSearchRecordType, supportsQueryRecordType, supportsSearch, supportsSearchRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getSearchSession

SearchSession getSearchSession(Proxy proxy)
                               throws OperationFailedException

Gets the OsidSession associated with the search service.

Parameters:

proxy - the proxy

Returns:

a SearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSearch() is false

Compliance:

optional - This method must be implemented if supportsSearch() is true.

getSearchSessionForEngine

SearchSession getSearchSessionForEngine(Id engineId,
                                      Proxy proxy)
                                        throws NotFoundException,
                                               OperationFailedException

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

Parameters:

engineId - the Id of an engine

proxy - the proxy

Returns:

a SearchSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSearch() and supportsVisibleFederation() are true

getEngineLookupSession

EngineLookupSession getEngineLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the engine lookup service.

Parameters:

proxy - the proxy

Returns:

an EngineLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineLookup() is false

Compliance:

optional - This method must be implemented if supportsEngineLookup() is true.

getEngineQuerySession

EngineQuerySession getEngineQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the engine query service.

Parameters:

proxy - the proxy

Returns:

an EngineQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineQuery() is false

Compliance:

optional - This method must be implemented if supportsEngineQuery() is true.

getEngineSearchSession

EngineSearchSession getEngineSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the engine search service.

Parameters:

proxy - the proxy

Returns:

an EngineSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineSearch() is false

Compliance:

optional - This method must be implemented if supportsEngineSearch() is true.

getEngineAdminSession

EngineAdminSession getEngineAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the engine administrative service.

Parameters:

proxy - the proxy

Returns:

an EngineAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineAdmin() is false

Compliance:

optional - This method must be implemented if supportsEngineAdmin() is true.

getEngineNotificationSession

EngineNotificationSession getEngineNotificationSession(EngineReceiver engineReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the engine notification service.

Parameters:

engineReceiver - the receiver

proxy - the proxy

Returns:

an EngineNotificationSession

Throws:

NullArgumentException - engineReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineNotification() is false

Compliance:

optional - This method must be implemented if supportsEngineNotification() is true.

getEngineHierarchySession

EngineHierarchySession getEngineHierarchySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy service.

Parameters:

proxy - the proxy

Returns:

an EngineHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchy() is false

Compliance:

optional - This method must be implemented if supportsEngineHierarchy() is true.

getEngineHierarchyDesignSession

EngineHierarchyDesignSession getEngineHierarchyDesignSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy design service.

Parameters:

proxy - the proxy

Returns:

an EngineHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsEngineHierarchyDesign() is true.