org.osid.search

Interface SearchManager

All Superinterfaces:

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

public interface SearchManager
extends OsidManager, SearchProfile

The search manager provides access to search sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with the engine administrative service.
EngineHierarchyDesignSession	getEngineHierarchyDesignSession() Gets the OsidSession associated with the engine hierarchy design service.
EngineHierarchySession	getEngineHierarchySession() Gets the OsidSession associated with the engine hierarchy service.
EngineLookupSession	getEngineLookupSession() Gets the OsidSession associated with the engine lookup service.
EngineNotificationSession	getEngineNotificationSession(EngineReceiver engineReceiver) Gets the OsidSession associated with the engine notification service.
EngineQuerySession	getEngineQuerySession() Gets the OsidSession associated with the engine query service.
EngineSearchSession	getEngineSearchSession() Gets the OsidSession associated with the engine search service.
SearchSession	getSearchSession() Gets the OsidSession associated with the search service.
SearchSession	getSearchSessionForEngine(Id engineId) Gets the OsidSession associated with the search service for the given engine.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                               throws OperationFailedException

Gets the OsidSession associated with the search service.

Returns:

a SearchSession

Throws:

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)
                                        throws NotFoundException,
                                               OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

a SearchSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the engine lookup service.

Returns:

an EngineLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineLookup() is false

Compliance:

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

getEngineQuerySession

EngineQuerySession getEngineQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the engine query service.

Returns:

an EngineQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineQuery() is false

Compliance:

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

getEngineSearchSession

EngineSearchSession getEngineSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the engine search service.

Returns:

an EngineSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineSearch() is false

Compliance:

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

getEngineAdminSession

EngineAdminSession getEngineAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the engine administrative service.

Returns:

an EngineAdminSession

Throws:

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)
                                                       throws OperationFailedException

Gets the OsidSession associated with the engine notification service.

Parameters:

engineReceiver - the receiver

Returns:

an EngineNotificationSession

Throws:

NullArgumentException - engineReceiver 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy service.

Returns:

an EngineHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchy() is false

Compliance:

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

getEngineHierarchyDesignSession

EngineHierarchyDesignSession getEngineHierarchyDesignSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the engine hierarchy design service.

Returns:

an EngineierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEngineHierarchyDesign() is false

Compliance:

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