Interface | osid.configuration.batch.ConfigurationBatchManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getValueBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.configuration.batch.ValueBatchAdminSession | a ValueBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsValueBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsValueBatchAdmin()
is true. | |
Method | getValueBatchAdminSessionForConfiguration | ||
Description |
Gets the | ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration |
Return | osid.configuration.batch.ValueBatchAdminSession | a ValueBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsValueBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getParameterBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.configuration.batch.ParameterBatchAdminSession | a ParameterBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsParameterBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsParameterBatchAdmin()
is true. | |
Method | getParameterBatchAdminSessionForConfiguration | ||
Description |
Gets the | ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration |
Return | osid.configuration.batch.ParameterBatchAdminSession | a ParameterBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsParameterBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getConfigurationBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.configuration.batch.ConfigurationBatchAdminSession | a ConfigurationBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConfigurationBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsConfigurationBatchAdmin()
is true. |