org.osid.configuration.batch

Interface ConfigurationBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ConfigurationBatchProfile, OsidProfile, OsidProxyManager, Sourceable

public interface ConfigurationBatchProxyManager
extends OsidProxyManager, ConfigurationBatchProfile

The configuration batch proxy manager provides access to configuration batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationBatchAdminSession	getConfigurationBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk configuration administration service.
ParameterBatchAdminSession	getParameterBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk parameter administration service.
ParameterBatchAdminSession	getParameterBatchAdminSessionForConfiguration(Id configurationId, Proxy proxy) Gets the OsidSession associated with the bulk parameter administration service for the given configuration.
ValueBatchAdminSession	getValueBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk value administration service.
ValueBatchAdminSession	getValueBatchAdminSessionForConfiguration(Id configurationId, Proxy proxy) Gets the OsidSession associated with the bulk value administration service for the given configuration.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.configuration.batch.ConfigurationBatchProfile

supportsConfigurationBatchAdmin, supportsParameterBatchAdmin, supportsValueBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getValueBatchAdminSession

ValueBatchAdminSession getValueBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk value administration service.

Parameters:

proxy - a proxy

Returns:

a ValueBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsValueBatchAdmin() is true.

getValueBatchAdminSessionForConfiguration

ValueBatchAdminSession getValueBatchAdminSessionForConfiguration(Id configurationId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

configurationId - the Id of the Configuration

proxy - a proxy

Returns:

a ValueBatchAdminSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsValueBatchAdmin() and supportsVisibleFederation() are true

getParameterBatchAdminSession

ParameterBatchAdminSession getParameterBatchAdminSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk parameter administration service.

Parameters:

proxy - a proxy

Returns:

a ParameterBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsParameterBatchAdmin() is true.

getParameterBatchAdminSessionForConfiguration

ParameterBatchAdminSession getParameterBatchAdminSessionForConfiguration(Id configurationId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

configurationId - the Id of the Configuration

proxy - a proxy

Returns:

a ParameterBatchAdminSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsParameterBatchAdmin() and supportsVisibleFederation() are true

getConfigurationBatchAdminSession

ConfigurationBatchAdminSession getConfigurationBatchAdminSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk configuration administration service.

Parameters:

proxy - a proxy

Returns:

a ConfigurationBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsConfigurationBatchAdmin() is true.