OSID - osid.lexicon.LexiconProfile Service Interface Definition

Interface	osid.lexicon.LexiconProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.lexicon.LexiconManager`
Implemented By	`osid.lexicon.LexiconProxyManager`
Description	The lexicon profile describes the interoperability among lexicon services.
Method	supportsVisibleFederation
Description	Tests if any press federation is exposed. Federation is exposed when a specific press may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of presses appears as a single press.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsText
Description	Tests if a text service is supported for the current agent.
Return	`boolean`		`true` if text is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextLookup
Description	Tests if looking up texts is supported.
Return	`boolean`		`true` if text lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextQuery
Description	Tests if querying texts is supported.
Return	`boolean`		`true` if text query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextSearch
Description	Tests if searching texts is supported.
Return	`boolean`		`true` if text search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextAdmin
Description	Tests if a text administrative service is supported.
Return	`boolean`		`true` if text administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextNotification
Description	Tests if a text notification service is supported.
Return	`boolean`		`true` if text notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextPress
Description	Tests if a text press lookup service is supported.
Return	`boolean`		`true` if a text press lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextPressAssignment
Description	Tests if a text press assignment service is supported.
Return	`boolean`		`true` if a text to press assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextSmartPress
Description	Tests if a text smart press service is supported.
Return	`boolean`		`true` if an v smart press service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextReturn
Description	Tests if returning texts is supported.
Return	`boolean`		`true` if returning texts is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomLookup
Description	Tests if looking up idioms is supported.
Return	`boolean`		`true` if idiom lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomQuery
Description	Tests if querying idioms is supported.
Return	`boolean`		`true` if idiom query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomSearch
Description	Tests if searching idioms is supported.
Return	`boolean`		`true` if idiom search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomAdmin
Description	Tests if an idiom administrative service is supported.
Return	`boolean`		`true` if idiom administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomNotification
Description	Tests if an idiom notification service is supported.
Return	`boolean`		`true` if idiom notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomPress
Description	Tests if an idiom press lookup service is supported.
Return	`boolean`		`true` if an idiom press lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomPressAssignment
Description	Tests if an idiom press assignment service is supported.
Return	`boolean`		`true` if an idiom to press assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomSmartPress
Description	Tests if an idiom smart press service is supported.
Return	`boolean`		`true` if a smart press service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterLookup
Description	Tests if looking up parameters is supported.
Return	`boolean`		`true` if parameter lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterQuery
Description	Tests if querying parameters is supported.
Return	`boolean`		`true` if parameter query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterSearch
Description	Tests if searching parameters is supported.
Return	`boolean`		`true` if parameter search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterAdmin
Description	Tests if parameter administrative service is supported.
Return	`boolean`		`true` if parameter administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterNotification
Description	Tests if a parameter notification service is supported.
Return	`boolean`		`true` if parameter notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterPress
Description	Tests if a parameter press lookup service is supported.
Return	`boolean`		`true` if a parameter press lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterPressAssignment
Description	Tests if a parameter press service is supported.
Return	`boolean`		`true` if parameter to press assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterSmartPress
Description	Tests if a parameter smart press lookup service is supported.
Return	`boolean`		`true` if a parameter smart press service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressLookup
Description	Tests if looking up presses is supported.
Return	`boolean`		`true` if press lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressQuery
Description	Tests if querying presses is supported.
Return	`boolean`		`true` if an press query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressSearch
Description	Tests if searching presses is supported.
Return	`boolean`		`true` if press search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressAdmin
Description	Tests if press administrative service is supported.
Return	`boolean`		`true` if press administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressNotification
Description	Tests if an press notification service is supported.
Return	`boolean`		`true` if press notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressHierarchy
Description	Tests for the availability of an press hierarchy traversal service.
Return	`boolean`		`true` if press hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsPressHierarchyDesign
Description	Tests for the availability of an press hierarchy design service.
Return	`boolean`		`true` if press hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLexiconBatch
Description	Tests for the availability of a lexicon batch service.
Return	`boolean`		`true` if lexicon batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTextRecordTypes
Description	Gets the supported `Text` record types.
Return	`osid.type.TypeList`		a list containing the supported `Text` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextRecordType
Description	Tests if the given `Text` record type is supported.
Parameters	`osid.type.Type`	`textRecordType`	a `Type` indicating a `Text` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`textRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTextSearchRecordTypes
Description	Gets the supported `Text` search types.
Return	`osid.type.TypeList`		a list containing the supported `Text` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextSearchRecordType
Description	Tests if the given `Text` search type is supported.
Parameters	`osid.type.Type`	`textSearchRecordType`	a `Type` indicating a `Text` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`effiortSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomRecordTypes
Description	Gets the supported `Idiom` record types.
Return	`osid.type.TypeList`		a list containing the supported `Idiom` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomRecordType
Description	Tests if the given `Idiom` record type is supported.
Parameters	`osid.type.Type`	`idiomRecordType`	a `Type` indicating a `Idiom` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`idiomRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomSearchRecordTypes
Description	Gets the supported `Idiom` search types.
Return	`osid.type.TypeList`		a list containing the supported `Idiom` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomSearchRecordType
Description	Tests if the given `Idiom` search type is supported.
Parameters	`osid.type.Type`	`idiomSearchRecordType`	a `Type` indicating a `Idiom` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`idiomSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterRecordTypes
Description	Gets the supported `Parameter` record types.
Return	`osid.type.TypeList`		a list containing the supported `Parameter` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterRecordType
Description	Tests if the given `Parameter` record type is supported.
Parameters	`osid.type.Type`	`parameterRecordType`	a `Type` indicating a `Parameter` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`parameterRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterSearchRecordTypes
Description	Gets the supported `Parameter` search types.
Return	`osid.type.TypeList`		a list containing the supported `Parameter` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterSearchRecordType
Description	Tests if the given `Parameter` search type is supported.
Parameters	`osid.type.Type`	`parameterSearchRecordType`	a `Type` indicating a `Parameter` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`parameterSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPressRecordTypes
Description	Gets the supported `Press` record types.
Return	`osid.type.TypeList`		a list containing the supported `Press` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressRecordType
Description	Tests if the given `Press` record type is supported.
Parameters	`osid.type.Type`	`pressRecordType`	a `Type` indicating a `Press` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pressRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPressSearchRecordTypes
Description	Gets the supported `Press` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Press` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressSearchRecordType
Description	Tests if the given `Press` search record type is supported.
Parameters	`osid.type.Type`	`pressSearchRecordType`	a `Type` indicating a `Press` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pressSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.