OSID Logo
OSID Specifications
lexicon package
Version 3.1.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.TextSession a TextSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsText() is false
Complianceoptional This method must be implemented if supportsText() is true.
MethodgetTextSessionForPress
Description

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

Parametersosid.id.IdpressId the Id of the press
Returnosid.lexicon.TextSession a TextSession
ErrorsNOT_FOUND no Press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsText() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsText() and supportsVisibleFederation() are true
MethodgetTextLookupSession
Description

Gets the OsidSession associated with the text lookup service.

Returnosid.lexicon.TextLookupSession a TextLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextLookup() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.TextLookupSession a TextLookupSession
ErrorsNOT_FOUND no Press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTextLookup() and supportsVisibleFederation() are true
MethodgetTextQuerySession
Description

Gets the OsidSession associated with the text query service.

Returnosid.lexicon.TextQuerySession a TextQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextQuery() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.TextQuerySession a TextQuerySession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTextQuery() and supportsVisibleFederation() are true
MethodgetTextSearchSession
Description

Gets the OsidSession associated with the text search service.

Returnosid.lexicon.TextSearchSession a TextSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextSearch() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.TextSearchSession a TextSearchSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTextSearch() and supportsVisibleFederation() are true
MethodgetTextAdminSession
Description

Gets the OsidSession associated with the text administration service.

Returnosid.lexicon.TextAdminSession a TextAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextAdmin() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.TextAdminSession a TextAdminSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTextAdmin() and supportsVisibleFederation() are true
MethodgetTextNotificationSession
Description

Gets the OsidSession associated with the text notification service.

Parametersosid.lexicon.TextReceivertextReceiver the notification callback
Returnosid.lexicon.TextNotificationSession a TextNotificationSession
ErrorsNULL_ARGUMENT textReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextNotification() is false
Complianceoptional This 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.TextReceivertextReceiver the notification callback
osid.id.IdpressId the Id of the Press
Returnosid.lexicon.TextNotificationSession a TextNotificationSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT textReceiver or pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTextNotification() and supportsVisibleFederation() are true
MethodgetTextPressSession
Description

Gets the OsidSession to lookup text/press mappings.

Returnosid.lexicon.TextPressSession a TextPressSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextPress() is false
Complianceoptional This method must be implemented if supportsTextPress() is true.
MethodgetTextPressAssignmentSession
Description

Gets the OsidSession associated with assigning texts to presses.

Returnosid.lexicon.TextPressAssignmentSession a TextPressAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextPressAssignment() is false
Complianceoptional This method must be implemented if supportsTextPressAssignment() is true.
MethodgetTextSmartPressSession
Description

Gets the OsidSession to manage text smart presses.

Parametersosid.id.IdpressId the Id of the Press
Returnosid.lexicon.TextSmartPressSession a TextSmartPressSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTextSmartPress() is false
Complianceoptional This method must be implemented if supportsTextSmartPress() is true.
MethodgetIdiomLookupSession
Description

Gets the OsidSession associated with the idiom lookup service.

Returnosid.lexicon.IdiomLookupSession a IdiomLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomLookup() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.IdiomLookupSession a IdiomLookupSession
ErrorsNOT_FOUND no Press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsIdiomLookup() and supportsVisibleFederation() are true
MethodgetIdiomQuerySession
Description

Gets the OsidSession associated with the idiom query service.

Returnosid.lexicon.IdiomQuerySession a IdiomQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomQuery() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.IdiomQuerySession a IdiomQuerySession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsIdiomQuery() and supportsVisibleFederation() are true
MethodgetIdiomSearchSession
Description

Gets the OsidSession associated with the idiom search service.

Returnosid.lexicon.IdiomSearchSession a IdiomSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomSearch() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.IdiomSearchSession a IdiomSearchSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsIdiomSearch() and supportsVisibleFederation() are true
MethodgetIdiomAdminSession
Description

Gets the OsidSession associated with the idiom administration service.

Returnosid.lexicon.IdiomAdminSession a IdiomAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomAdmin() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.IdiomAdminSession a IdiomAdminSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsIdiomAdmin() and supportsVisibleFederation() are true
MethodgetIdiomNotificationSession
Description

Gets the OsidSession associated with the idiom notification service.

Parametersosid.lexicon.IdiomReceiveridiomReceiver the notification callback
Returnosid.lexicon.IdiomNotificationSession a IdiomNotificationSession
ErrorsNULL_ARGUMENT idiomReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomNotification() is false
Complianceoptional This 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.IdiomReceiveridiomReceiver the notification callback
osid.id.IdpressId the Id of the Press
Returnosid.lexicon.IdiomNotificationSession a IdiomNotificationSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT idiomReceiver or pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsIdiomNotification() and supportsVisibleFederation() are true
MethodgetIdiomPressSession
Description

Gets the OsidSession to lookup idiom/press mappings.

Returnosid.lexicon.IdiomPressSession a IdiomPressSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomPress() is false
Complianceoptional This method must be implemented if supportsIdiomPress() is true.
MethodgetIdiomPressAssignmentSession
Description

Gets the OsidSession associated with assigning idioms to presses.

Returnosid.lexicon.IdiomPressAssignmentSession a IdiomPressAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomPressAssignment() is false
Complianceoptional This method must be implemented if supportsIdiomPressAssignment() is true.
MethodgetIdiomSmartPressSession
Description

Gets the OsidSession to manage idiom smart presses.

Parametersosid.id.IdpressId the Id of the Press
Returnosid.lexicon.IdiomSmartPressSession a IdiomSmartPressSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIdiomSmartPress() is false
Complianceoptional This method must be implemented if supportsIdiomSmartPress() is true.
MethodgetParameterLookupSession
Description

Gets the OsidSession associated with the parameter lookup service.

Returnosid.lexicon.ParameterLookupSession a ParameterLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterLookup() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.ParameterLookupSession a ParameterLookupSession
ErrorsNOT_FOUND no Press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterLookup() and supportsVisibleFederation() are true
MethodgetParameterQuerySession
Description

Gets the OsidSession associated with the parameter query service.

Returnosid.lexicon.ParameterQuerySession a ParameterQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterQuery() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.ParameterQuerySession a ParameterQuerySession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterQuery() and supportsVisibleFederation() are true
MethodgetParameterSearchSession
Description

Gets the OsidSession associated with the parameter search service.

Returnosid.lexicon.ParameterSearchSession a ParameterSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterSearch() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.ParameterSearchSession a ParameterSearchSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterSearch() and supportsVisibleFederation() are true
MethodgetParameterAdminSession
Description

Gets the OsidSession associated with the parameter administration service.

Returnosid.lexicon.ParameterAdminSession a ParameterAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterAdmin() is false
Complianceoptional This 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.IdpressId the Id of the Press
Returnosid.lexicon.ParameterAdminSession a ParameterAdminSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterAdmin() and supportsVisibleFederation() are true
MethodgetParameterNotificationSession
Description

Gets the OsidSession associated with the parameter notification service.

Parametersosid.lexicon.ParameterReceiverparameterReceiver the notification callback
Returnosid.lexicon.ParameterNotificationSession a ParameterNotificationSession
ErrorsNULL_ARGUMENT parameterReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterNotification() is false
Complianceoptional This 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.ParameterReceiverparameterReceiver the notification callback
osid.id.IdpressId the Id of the Press
Returnosid.lexicon.ParameterNotificationSession a ParameterNotificationSession
ErrorsNOT_FOUND no press found by the given Id
NULL_ARGUMENT parameterReceiver or pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterNotification() and supportsVisibleFederation() are true
MethodgetParameterPressSession
Description

Gets the OsidSession to lookup parameter/press mappings.

Returnosid.lexicon.ParameterPressSession a ParameterPressSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterPress() is false
Complianceoptional This method must be implemented if supportsParameterPress() is true.
MethodgetParameterPressAssignmentSession
Description

Gets the OsidSession associated with assigning parameters to presses.

Returnosid.lexicon.ParameterPressAssignmentSession a ParameterPressAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterPressAssignment() is false
Complianceoptional This method must be implemented if supportsParameterPressAssignment() is true.
MethodgetParameterSmartPressSession
Description

Gets the OsidSession to manage parameter smart presses.

Parametersosid.id.IdpressId the Id of the press
Returnosid.lexicon.ParameterSmartPressSession a ParameterSmartPressSession
ErrorsNOT_FOUND no Press found by the given Id
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterSmartPress() is false
Complianceoptional This method must be implemented if supportsParameterSmartPress() is true.
MethodgetPressLookupSession
Description

Gets the OsidSession associated with the press lookup service.

Returnosid.lexicon.PressLookupSession a PressLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPressLookup() is false
Complianceoptional This method must be implemented if supportsPressLookup() is true.
MethodgetPressQuerySession
Description

Gets the OsidSession associated with the press query service.

Returnosid.lexicon.PressQuerySession a PressQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPressQuery() is false
Complianceoptional This method must be implemented if supportsPressQuery() is true.
MethodgetPressSearchSession
Description

Gets the OsidSession associated with the press search service.

Returnosid.lexicon.PressSearchSession a PressSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPressSearch() is false
Complianceoptional This method must be implemented if supportsPressSearch() is true.
MethodgetPressAdminSession
Description

Gets the OsidSession associated with the press administrative service.

Returnosid.lexicon.PressAdminSession a PressAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPressAdmin() is false
Complianceoptional This method must be implemented if supportsPressAdmin() is true.
MethodgetPressNotificationSession
Description

Gets the OsidSession associated with the press notification service.

Parametersosid.lexicon.PressReceiverpressReceiver the notification callback
Returnosid.lexicon.PressNotificationSession a PressNotificationSession
ErrorsNULL_ARGUMENT pressReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPressNotification() is false
Complianceoptional This method must be implemented if supportsPressNotification() is true.
MethodgetPressHierarchySession
Description

Gets the OsidSession associated with the press hierarchy service.

Returnosid.lexicon.PressHierarchySession a PressHierarchySession for presses
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPressHierarchy() is false
Complianceoptional This method must be implemented if supportsPressHierarchy() is true.
MethodgetPressHierarchyDesignSession
Description

Gets the OsidSession associated with the press hierarchy design service.

Returnosid.lexicon.PressHierarchyDesignSession a HierarchyDesignSession for presses
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPressHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsPressHierarchyDesign() is true.
MethodgetLexiconBatchManager
Description

Gets the LexiconBatchManager.

Returnosid.lexicon.batch.LexiconBatchManager a LexiconBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsLexiconBatch() is false
Complianceoptional This method must be implemented if supportsLexiconBatch() is true.