org.osid.search

Interface SearchProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

SearchManager, SearchProxyManager

public interface SearchProfile
extends OsidProfile

The search profile describes the interoperability among search services.

Method Summary

Methods

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

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any engine federation is exposed. Federation is exposed when a specific engine may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of engines appears as a single engine.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSearch

boolean supportsSearch()

Tests if search is supported.

Returns:

true if search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEngineLookup

boolean supportsEngineLookup()

Tests for the availability of an engine lookup service.

Returns:

true if engine lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEngineQuery

boolean supportsEngineQuery()

Tests if querying for engines is available.

Returns:

true if engine query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEngineSearch

boolean supportsEngineSearch()

Tests if searching for engines is available.

Returns:

true if engine search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEngineAdmin

boolean supportsEngineAdmin()

Tests for the availability of an engine administrative service for creating and deleting engines.

Returns:

true if engine administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEngineNotification

boolean supportsEngineNotification()

Tests for the availability of an engine notification service.

Returns:

true if engine notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsEngineHierarchy

boolean supportsEngineHierarchy()

Tests for the availability of an engine hierarchy traversal service.

Returns:

true if engine hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEngineHierarchyDesign

boolean supportsEngineHierarchyDesign()

Tests for the availability of an engine hierarchy design service.

Returns:

true if engine hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

getQueryRecordTypes

TypeList getQueryRecordTypes()

Gets the supported query record types.

Returns:

a list containing the supported query record types

Compliance:

mandatory - This method must be implemented.

supportsQueryRecordType

boolean supportsQueryRecordType(Type queryRecordType)

Tests if the given query record type is supported.

Parameters:

queryRecordType - a Type indicating a query record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - queryRecordType is null

Compliance:

mandatory - This method must be implemented.

getSearchRecordTypes

TypeList getSearchRecordTypes()

Gets the supported search record types.

Returns:

a list containing the supported search record types

Compliance:

mandatory - This method must be implemented.

supportsSearchRecordType

boolean supportsSearchRecordType(Type searchRecordType)

Tests if the given search record type is supported.

Parameters:

searchRecordType - a Type indicating a search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - searchRecordType is null

Compliance:

mandatory - This method must be implemented.

getEngineRecordTypes

TypeList getEngineRecordTypes()

Gets the supported Engine record types.

Returns:

a list containing the supported engine record types

Compliance:

mandatory - This method must be implemented.

supportsEngineRecordType

boolean supportsEngineRecordType(Type engineRecordType)

Tests if the given Engine record type is supported.

Parameters:

engineRecordType - a Type indicating an Engine record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - engineRecordType is null

Compliance:

mandatory - This method must be implemented.

getEngineSearchRecordTypes

TypeList getEngineSearchRecordTypes()

Gets the supported engine search record types.

Returns:

a list containing the supported engine search record types

Compliance:

mandatory - This method must be implemented.

supportsEngineSearchRecordType

boolean supportsEngineSearchRecordType(Type engineSearchRecordType)

Tests if the given engine search record type is supported.

Parameters:

engineSearchRecordType - a Type indicating an engine record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - engineSearchRecordType is null

Compliance:

mandatory - This method must be implemented.