OSID Logo
OSID Specifications
configuration batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.batch.ConfigurationBatchManager
Implementsosid.OsidManager
osid.configuration.batch.ConfigurationBatchProfile
Description

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

  • ValueBatchAdminSession: a session to create, modify and delete values in bulk
  • ParameterBatchSession: a session to create, modify and delete parameters in bulk
  • ConfigurationBatchAdminSession: a session to create, modify and delete configurations in bulk
MethodgetValueBatchAdminSession
Description

Gets the OsidSession associated with the bulk value administration service.

Returnosid.configuration.batch.ValueBatchAdminSessiona ValueBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsValueBatchAdmin() is true.
MethodgetValueBatchAdminSessionForConfiguration
Description

Gets the OsidSession associated with the bulk value administration service for the given configuration.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.batch.ValueBatchAdminSessiona ValueBatchAdminSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsValueBatchAdmin() and supportsVisibleFederation() are true
MethodgetParameterBatchAdminSession
Description

Gets the OsidSession associated with the bulk parameter administration service.

Returnosid.configuration.batch.ParameterBatchAdminSessiona ParameterBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsParameterBatchAdmin() is true.
MethodgetParameterBatchAdminSessionForConfiguration
Description

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

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.batch.ParameterBatchAdminSessiona ParameterBatchAdminSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterBatchAdmin() and supportsVisibleFederation() are true
MethodgetConfigurationBatchAdminSession
Description

Gets the OsidSession associated with the bulk configuration administration service.

Returnosid.configuration.batch.ConfigurationBatchAdminSessiona ConfigurationBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConfigurationBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsConfigurationBatchAdmin() is true.