OSID Logo
OSID Specifications
lexicon batch package
Version 3.0.0
Interfaceosid.lexicon.batch.LexiconBatchManager
Implementsosid.OsidManager
osid.lexicon.batch.LexiconBatchProfile
Used Byosid.lexicon.LexiconManager
Description

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

  • TextBatchAdminSession : a session to create, modify, and delete texts in bulk
  • IdiomBatchAdminSession : a session to create, modify, and delete idioms in bulk
  • ParameterBatchAdminSession : a session to create, modify, and delete parameters in bulk
  • PressBatchAdminSession : a session to create, modify, and delete presses in bulk
MethodgetTextBatchAdminSession
Description

Gets the OsidSession associated with the bulk text administration service.

Returnosid.lexicon.batch.TextBatchAdminSessiona TextBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTextBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsTextBatchAdmin() is true .
MethodgetTextBatchAdminSessionForPress
Description

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

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.batch.TextBatchAdminSessiona TextBatchAdminSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsOsidObjectBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTextAdmin() and supportsVisibleFederation() are true
MethodgetIdiomBatchAdminSession
Description

Gets the OsidSession associated with the bulk text administration service.

Returnosid.lexicon.batch.IdiomBatchAdminSessionan IdiomBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIdiomBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsIdiomBatchAdmin() is true .
MethodgetIdiomBatchAdminSessionForPress
Description

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

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.batch.IdiomBatchAdminSessionan IdiomBatchAdminSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsOsidObjectBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIdiomAdmin() and supportsVisibleFederation() are true
MethodgetParameterBatchAdminSession
Description

Gets the OsidSession associated with the bulk parameter administration service.

Returnosid.lexicon.batch.ParameterBatchAdminSessiona ParameterBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsParameterBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsParameterBatchAdmin() is true .
MethodgetParameterBatchAdminSessionForPress
Description

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

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.lexicon.batch.ParameterBatchAdminSessiona ParameterBatchAdminSession
ErrorsNOT_FOUNDno Press found by the given Id
NULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsOsidObjectBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterAdmin() and supportsVisibleFederation() are true
MethodgetPressBatchAdminSession
Description

Gets the OsidSession associated with the bulk press administration service.

Returnosid.lexicon.batch.PressBatchAdminSessiona PressBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsPressBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPressBatchAdmin() is true .