Interface ConfigurationBatchManager

All Superinterfaces:

AutoCloseable, Closeable, ConfigurationBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface ConfigurationBatchManager
extends OsidManager, ConfigurationBatchProfile

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

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface ConfigurationBatchProfile

supportsConfigurationBatchAdmin, supportsParameterBatchAdmin, supportsValueBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsConfigurationBatchAdmin()	Tests if bulk administration of configurations is available.
boolean	supportsParameterBatchAdmin()	Tests if bulk administration of parameters is available.
boolean	supportsValueBatchAdmin()	Tests if bulk administration of values is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getValueBatchAdminSession

ValueBatchAdminSession getValueBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk value administration service.

Returns:

a ValueBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsValueBatchAdmin()} is {@code true} .

getValueBatchAdminSessionForConfiguration

ValueBatchAdminSession getValueBatchAdminSessionForConfiguration(Id configurationId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueBatchAdminSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsValueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getParameterBatchAdminSession

ParameterBatchAdminSession getParameterBatchAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk parameter administration service.

Returns:

a ParameterBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterBatchAdmin()} is {@code true} .

getParameterBatchAdminSessionForConfiguration

ParameterBatchAdminSession getParameterBatchAdminSessionForConfiguration(Id configurationId)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterBatchAdminSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getConfigurationBatchAdminSession

ConfigurationBatchAdminSession getConfigurationBatchAdminSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the bulk configuration administration service.

Returns:

a ConfigurationBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationBatchAdmin()} is {@code true} .