Interface SearchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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. 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface SearchProfile

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

Modifier and Type	Method	Description
TypeList	getEngineRecordTypes()	Gets the supported Engine record types.
TypeList	getEngineSearchRecordTypes()	Gets the supported engine search record types.
TypeList	getQueryRecordTypes()	Gets the supported query record types.
TypeList	getSearchRecordTypes()	Gets the supported search record types.
boolean	supportsEngineAdmin()	Tests for the availability of an engine administrative service for creating and deleting engines.
boolean	supportsEngineHierarchy()	Tests for the availability of an engine hierarchy traversal service.
boolean	supportsEngineHierarchyDesign()	Tests for the availability of an engine hierarchy design service.
boolean	supportsEngineLookup()	Tests for the availability of an engine lookup service.
boolean	supportsEngineNotification()	Tests for the availability of an engine notification service.
boolean	supportsEngineQuery()	Tests if querying for engines is available.
boolean	supportsEngineRecordType(Type engineRecordType)	Tests if the given Engine record type is supported.
boolean	supportsEngineSearch()	Tests if searching for engines is available.
boolean	supportsEngineSearchRecordType(Type engineSearchRecordType)	Tests if the given engine search record type is supported.
boolean	supportsQueryRecordType(Type queryRecordType)	Tests if the given query record type is supported.
boolean	supportsSearch()	Tests if search is supported.
boolean	supportsSearchRecordType(Type searchRecordType)	Tests if the given search record type is supported.
boolean	supportsVisibleFederation()	Tests if any engine federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids.
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsSearch()} is {@code 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 {@code supportsSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEngineLookup()} is {@code 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 {@code supportsEngineQuery()} is {@code 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 {@code supportsEngineSearch()} is {@code 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 {@code supportsEngineAdmin()} is {@code 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 {@code supportsEngineNotification()} is {@code 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 {@code supportsEngineHierarchy()} is {@code 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 {@code supportsEngineHierarchyDesign()} is {@code true}.