OSID Logo
OSID Specifications
lexicon package
Version 3.0.0
Interfaceosid.lexicon.LexiconManager
Implementsosid.OsidManager
osid.lexicon.LexiconProfile
Description

The lexicon manager provides access to lexicon sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • TextSession : a session for resolving text
  • TextLookupSession : a session to retrieve texts
  • TextQuerySession : a session to query for textss
  • TextSearchSession : a session to search for texts
  • TextAdminSession : a session to create and delete texts
  • TextNotificationSession : a session to receive notifications pertaining to text changes
  • TextPressSession : a session to look up text press mappings
  • TextPressAssignmentSession : a session to manage text to press mappings
  • TextSmartPressSession : a session to manage dynamic presses of texts
  • IdiomLookupSession : a session to retrieve idioms
  • IdiomQuerySession : a session to query for idioms
  • IdiomSearchSession : a session to search for idioms
  • IdiomAdminSession : a session to create and delete idioms
  • IdiomNotificationSession : a session to receive notifications pertaining to idiom changes
  • IdiomPressSession : a session to look up idiom press mappings
  • IdiomPressAssignmentSession : a session to manage idioms to press mappings
  • IdiomSmartPressSession : a session to manage dynamic presses of idioms
  • ParameterLookupSession : a session to retrieve parameters
  • ParameterQuerySession : a session to query for parameters
  • ParameterSearchSession : a session to search for parameters
  • ParameterAdminSession : a session to create and delete parameters
  • ParameterNotificationSession : a session to receive notifications pertaining to parameter changes
  • ParameterPressSession : a session to look up parameter press mappings
  • ParameterPressAssignmentSession : a session to manage parameter to press mappings
  • ParameterSmartPressSession : a session to manage dynamic presses of parameters
  • PressLookupSession : a session to retrieve presses
  • PressQuerySession : a session to search for presses
  • PressSearchSession : a session to search for presses
  • PressAdminSession : a session to create and delete presses
  • PressNotificationSession : a session to receive notifications pertaining to press changes
  • PressHierarchySession : a session to traverse a hierarchy of press
  • PressHierarchyDesignSession : a session to manage an press hierarchy
MethodgetTextSession
Description

Gets the OsidSession associated with the my text service.

Returnosid.lexicon.TextSessiona TextSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsText() is false
ComplianceoptionalThis method must be implemented if supportsText() is true .
MethodgetTextSessionForPress
Description

Gets the OsidSession associated with the text service for the given press.

Parametersosid.id.IdpressIdthe Id of the press
Returnosid.lexicon.TextSessiona TextSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsText() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsText() and supportsVisibleFederation() are true
MethodgetTextLookupSession
Description

Gets the OsidSession associated with the text lookup service.

Returnosid.lexicon.TextLookupSessiona TextLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextLookup() is false
ComplianceoptionalThis method must be implemented if supportsTextLookup() is true .
MethodgetTextLookupSessionForPress
Description

Gets the OsidSession associated with the text lookup service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.TextLookupSessiona TextLookupSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTextLookup() and supportsVisibleFederation() are true
MethodgetTextQuerySession
Description

Gets the OsidSession associated with the text query service.

Returnosid.lexicon.TextQuerySessiona TextQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextQuery() is false
ComplianceoptionalThis method must be implemented if supportsTextQuery() is true .
MethodgetTextQuerySessionForPress
Description

Gets the OsidSession associated with the text query service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.TextQuerySessiona TextQuerySession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTextQuery() and supportsVisibleFederation() are true
MethodgetTextSearchSession
Description

Gets the OsidSession associated with the text search service.

Returnosid.lexicon.TextSearchSessiona TextSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextSearch() is false
ComplianceoptionalThis method must be implemented if supportsTextSearch() is true .
MethodgetTextSearchSessionForPress
Description

Gets the OsidSession associated with the text search service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.TextSearchSessiona TextSearchSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTextSearch() and supportsVisibleFederation() are true
MethodgetTextAdminSession
Description

Gets the OsidSession associated with the text administration service.

Returnosid.lexicon.TextAdminSessiona TextAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextAdmin() is false
ComplianceoptionalThis method must be implemented if supportsTextAdmin() is true .
MethodgetTextAdminSessionForPress
Description

Gets the OsidSession associated with the text administration service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.TextAdminSessiona TextAdminSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTextAdmin() and supportsVisibleFederation() are true
MethodgetTextNotificationSession
Description

Gets the OsidSession associated with the text notification service.

Parametersosid.lexicon.TextReceivertextReceiverthe notification callback
Returnosid.lexicon.TextNotificationSessiona TextNotificationSession
ErrorsNULL_ARGUMENTtextReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextNotification() is false
ComplianceoptionalThis method must be implemented if supportsTextNotification() is true .
MethodgetTextNotificationSessionForPress
Description

Gets the OsidSession associated with the text notification service for the given press.

Parametersosid.lexicon.TextReceivertextReceiverthe notification callback
osid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.TextNotificationSessiona TextNotificationSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTtextReceiver or pressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTextNotification() and supportsVisibleFederation() are true
MethodgetTextPressSession
Description

Gets the OsidSession to lookup text/press mappings.

Returnosid.lexicon.TextPressSessiona TextPressSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextPress() is false
ComplianceoptionalThis method must be implemented if supportsTextPress() is true .
MethodgetTextPressAssignmentSession
Description

Gets the OsidSession associated with assigning texts to presses.

Returnosid.lexicon.TextPressAssignmentSessiona TextPressAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextPressAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTextPressAssignment() is true .
MethodgetTextSmartPressSession
Description

Gets the OsidSession to manage text smart presses.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.TextSmartPressSessiona TextSmartPressSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextSmartPress() is false
ComplianceoptionalThis method must be implemented if supportsTextSmartPress() is true .
MethodgetIdiomLookupSession
Description

Gets the OsidSession associated with the idiom lookup service.

Returnosid.lexicon.IdiomLookupSessiona IdiomLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomLookup() is false
ComplianceoptionalThis method must be implemented if supportsIdiomLookup() is true .
MethodgetIdiomLookupSessionForPress
Description

Gets the OsidSession associated with the idiom lookup service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.IdiomLookupSessiona IdiomLookupSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIdiomLookup() and supportsVisibleFederation() are true
MethodgetIdiomQuerySession
Description

Gets the OsidSession associated with the idiom query service.

Returnosid.lexicon.IdiomQuerySessiona IdiomQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomQuery() is false
ComplianceoptionalThis method must be implemented if supportsIdiomQuery() is true .
MethodgetIdiomQuerySessionForPress
Description

Gets the OsidSession associated with the idiom query service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.IdiomQuerySessiona IdiomQuerySession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIdiomQuery() and supportsVisibleFederation() are true
MethodgetIdiomSearchSession
Description

Gets the OsidSession associated with the idiom search service.

Returnosid.lexicon.IdiomSearchSessiona IdiomSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomSearch() is false
ComplianceoptionalThis method must be implemented if supportsIdiomSearch() is true .
MethodgetIdiomSearchSessionForPress
Description

Gets the OsidSession associated with the idiom search service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.IdiomSearchSessiona IdiomSearchSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIdiomSearch() and supportsVisibleFederation() are true
MethodgetIdiomAdminSession
Description

Gets the OsidSession associated with the idiom administration service.

Returnosid.lexicon.IdiomAdminSessiona IdiomAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomAdmin() is false
ComplianceoptionalThis method must be implemented if supportsIdiomAdmin() is true .
MethodgetIdiomAdminSessionForPress
Description

Gets the OsidSession associated with the idiom administration service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.IdiomAdminSessiona IdiomAdminSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIdiomAdmin() and supportsVisibleFederation() are true
MethodgetIdiomNotificationSession
Description

Gets the OsidSession associated with the idiom notification service.

Parametersosid.lexicon.IdiomReceiveridiomReceiverthe notification callback
Returnosid.lexicon.IdiomNotificationSessiona IdiomNotificationSession
ErrorsNULL_ARGUMENTidiomReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomNotification() is false
ComplianceoptionalThis method must be implemented if supportsIdiomNotification() is true .
MethodgetIdiomNotificationSessionForPress
Description

Gets the OsidSession associated with the idiom notification service for the given press.

Parametersosid.lexicon.IdiomReceiveridiomReceiverthe notification callback
osid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.IdiomNotificationSessiona IdiomNotificationSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTidiomReceiver or pressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIdiomNotification() and supportsVisibleFederation() are true
MethodgetIdiomPressSession
Description

Gets the OsidSession to lookup idiom/press mappings.

Returnosid.lexicon.IdiomPressSessiona IdiomPressSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomPress() is false
ComplianceoptionalThis method must be implemented if supportsIdiomPress() is true .
MethodgetIdiomPressAssignmentSession
Description

Gets the OsidSession associated with assigning idioms to presses.

Returnosid.lexicon.IdiomPressAssignmentSessiona IdiomPressAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomPressAssignment() is false
ComplianceoptionalThis method must be implemented if supportsIdiomPressAssignment() is true .
MethodgetIdiomSmartPressSession
Description

Gets the OsidSession to manage idiom smart presses.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.IdiomSmartPressSessiona IdiomSmartPressSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomSmartPress() is false
ComplianceoptionalThis method must be implemented if supportsIdiomSmartPress() is true .
MethodgetParameterLookupSession
Description

Gets the OsidSession associated with the parameter lookup service.

Returnosid.lexicon.ParameterLookupSessiona ParameterLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterLookup() is false
ComplianceoptionalThis method must be implemented if supportsParameterLookup() is true .
MethodgetParameterLookupSessionForPress
Description

Gets the OsidSession associated with the parameter lookup service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.ParameterLookupSessiona ParameterLookupSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterLookup() and supportsVisibleFederation() are true
MethodgetParameterQuerySession
Description

Gets the OsidSession associated with the parameter query service.

Returnosid.lexicon.ParameterQuerySessiona ParameterQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterQuery() is false
ComplianceoptionalThis method must be implemented if supportsParameterQuery() is true .
MethodgetParameterQuerySessionForPress
Description

Gets the OsidSession associated with the parameter query service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.ParameterQuerySessiona ParameterQuerySession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterQuery() and supportsVisibleFederation() are true
MethodgetParameterSearchSession
Description

Gets the OsidSession associated with the parameter search service.

Returnosid.lexicon.ParameterSearchSessiona ParameterSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterSearch() is false
ComplianceoptionalThis method must be implemented if supportsParameterSearch() is true .
MethodgetParameterSearchSessionForPress
Description

Gets the OsidSession associated with the parameter search service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.ParameterSearchSessiona ParameterSearchSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterSearch() and supportsVisibleFederation() are true
MethodgetParameterAdminSession
Description

Gets the OsidSession associated with the parameter administration service.

Returnosid.lexicon.ParameterAdminSessiona ParameterAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterAdmin() is false
ComplianceoptionalThis method must be implemented if supportsParameterAdmin() is true .
MethodgetParameterAdminSessionForPress
Description

Gets the OsidSession associated with the parameter administration service for the given press.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.ParameterAdminSessiona ParameterAdminSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterAdmin() and supportsVisibleFederation() are true
MethodgetParameterNotificationSession
Description

Gets the OsidSession associated with the parameter notification service.

Parametersosid.lexicon.ParameterReceiverparameterReceiverthe notification callback
Returnosid.lexicon.ParameterNotificationSessiona ParameterNotificationSession
ErrorsNULL_ARGUMENTparameterReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterNotification() is false
ComplianceoptionalThis method must be implemented if supportsParameterNotification() is true .
MethodgetParameterNotificationSessionForPress
Description

Gets the OsidSession associated with the parameter notification service for the given press.

Parametersosid.lexicon.ParameterReceiverparameterReceiverthe notification callback
osid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.ParameterNotificationSessiona ParameterNotificationSession
ErrorsNOT_FOUNDno press found by the given Id
NULL_ARGUMENTparameterReceiver or pressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterNotification() and supportsVisibleFederation() are true
MethodgetParameterPressSession
Description

Gets the OsidSession to lookup parameter/press mappings.

Returnosid.lexicon.ParameterPressSessiona ParameterPressSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterPress() is false
ComplianceoptionalThis method must be implemented if supportsParameterPress() is true .
MethodgetParameterPressAssignmentSession
Description

Gets the OsidSession associated with assigning parameters to presses.

Returnosid.lexicon.ParameterPressAssignmentSessiona ParameterPressAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterPressAssignment() is false
ComplianceoptionalThis method must be implemented if supportsParameterPressAssignment() is true .
MethodgetParameterSmartPressSession
Description

Gets the OsidSession to manage parameter smart presses.

Parametersosid.id.IdpressIdthe Id of the press
Returnosid.lexicon.ParameterSmartPressSessiona ParameterSmartPressSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterSmartPress() is false
ComplianceoptionalThis method must be implemented if supportsParameterSmartPress() is true .
MethodgetPressLookupSession
Description

Gets the OsidSession associated with the press lookup service.

Returnosid.lexicon.PressLookupSessiona PressLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressLookup() is false
ComplianceoptionalThis method must be implemented if supportsPressLookup() is true .
MethodgetPressQuerySession
Description

Gets the OsidSession associated with the press query service.

Returnosid.lexicon.PressQuerySessiona PressQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressQuery() is false
ComplianceoptionalThis method must be implemented if supportsPressQuery() is true .
MethodgetPressSearchSession
Description

Gets the OsidSession associated with the press search service.

Returnosid.lexicon.PressSearchSessiona PressSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressSearch() is false
ComplianceoptionalThis method must be implemented if supportsPressSearch() is true .
MethodgetPressAdminSession
Description

Gets the OsidSession associated with the press administrative service.

Returnosid.lexicon.PressAdminSessiona PressAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPressAdmin() is true .
MethodgetPressNotificationSession
Description

Gets the OsidSession associated with the press notification service.

Parametersosid.lexicon.PressReceiverpressReceiverthe notification callback
Returnosid.lexicon.PressNotificationSessiona PressNotificationSession
ErrorsNULL_ARGUMENTpressReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressNotification() is false
ComplianceoptionalThis method must be implemented if supportsPressNotification() is true .
MethodgetPressHierarchySession
Description

Gets the OsidSession associated with the press hierarchy service.

Returnosid.lexicon.PressHierarchySessiona PressHierarchySession for presses
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsPressHierarchy() is true .
MethodgetPressHierarchyDesignSession
Description

Gets the OsidSession associated with the press hierarchy design service.

Returnosid.lexicon.PressHierarchyDesignSessiona HierarchyDesignSession for presses
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsPressHierarchyDesign() is true .
MethodgetLexiconBatchManager
Description

Gets the LexiconBatchManager .

Returnosid.lexicon.batch.LexiconBatchManagera LexiconBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsLexiconBatch() is false
ComplianceoptionalThis method must be implemented if supportsLexiconBatch() is true .