OSID - osid.search.SearchProfile Service Interface Definition

Interface	osid.search.SearchProfile
Implements	`osid.OsidProfile`
Description	The search profile describes the interoperability among search services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSearch
Description	Tests if search is supported.
Return	`boolean`		`true` if search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineLookup
Description	Tests for the availability of an engine lookup service.
Return	`boolean`		`true` if engine lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineQuery
Description	Tests if querying for engines is available.
Return	`boolean`		`true` if engine query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineSearch
Description	Tests if searching for engines is available.
Return	`boolean`		`true` if engine search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineAdmin
Description	Tests for the availability of an engine administrative service for creating and deleting engines.
Return	`boolean`		`true` if engine administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineNotification
Description	Tests for the availability of an engine notification service.
Return	`boolean`		`true` if engine notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsEngineHierarchy
Description	Tests for the availability of an engine hierarchy traversal service.
Return	`boolean`		`true` if engine hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineHierarchyDesign
Description	Tests for the availability of an engine hierarchy design service.
Return	`boolean`		`true` if engine hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getQueryRecordTypes
Description	Gets the supported query record types.
Return	`osid.type.TypeList`		a list containing the supported query record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueryRecordType
Description	Tests if the given query record type is supported.
Parameters	`osid.type.Type`	`queryRecordType`	a `Type` indicating a query record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`queryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSearchRecordTypes
Description	Gets the supported search record types.
Return	`osid.type.TypeList`		a list containing the supported search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSearchRecordType
Description	Tests if the given search record type is supported.
Parameters	`osid.type.Type`	`searchRecordType`	a `Type` indicating a search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`searchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEngineRecordTypes
Description	Gets the supported `Engine` record types.
Return	`osid.type.TypeList`		a list containing the supported engine record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineRecordType
Description	Tests if the given `Engine` record type is supported.
Parameters	`osid.type.Type`	`engineRecordType`	a `Type` indicating an `Engine` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`engineRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEngineSearchRecordTypes
Description	Gets the supported engine search record types.
Return	`osid.type.TypeList`		a list containing the supported engine search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineSearchRecordType
Description	Tests if the given engine search record type is supported.
Parameters	`osid.type.Type`	`engineSearchRecordType`	a `Type` indicating an engine record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`engineSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.