OSID Logo
OSID Specifications
configuration batch package
Version 3.1.0
Interfaceosid.configuration.batch.ConfigurationBatchManager
Implementsosid.OsidManager
osid.configuration.batch.ConfigurationBatchProfile
Used Byosid.configuration.ConfigurationManager
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.ValueBatchAdminSession a ValueBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueBatchAdmin() is false
Complianceoptional This 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.IdconfigurationId the Id of the Configuration
Returnosid.configuration.batch.ValueBatchAdminSession a ValueBatchAdminSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This 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.ParameterBatchAdminSession a ParameterBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterBatchAdmin() is false
Complianceoptional This 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.IdconfigurationId the Id of the Configuration
Returnosid.configuration.batch.ParameterBatchAdminSession a ParameterBatchAdminSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This 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.ConfigurationBatchAdminSession a ConfigurationBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConfigurationBatchAdmin() is false
Complianceoptional This method must be implemented if supportsConfigurationBatchAdmin() is true.