Package de.elo.ix.client.config

Interface ConfigService

All Superinterfaces:

byps.BRemote, byps.Remote, de.elo.utils.net.Remote, Remote

public interface ConfigService
extends byps.BRemote

This interface provides functions to access configuration entries for several ELO modules and functionality. Configuration entries are used by ELO Flows, workspaces, teamspaces and the forms service for aspect metadata. The functions and data defined in this interface are not expected to be used for other purposes. The interface behavior might change in future versions and the data might be extended.

Since:

21.00.000.026

Method Summary

Modifier and Type	Method	Description
ConfigResult	checkinConfigurations(ClientInfo ci, List<ConfigRecord> configRecords)	Insert or update configuration entries.
ConfigResult	checkinConfigurationsBatch(ClientInfo ci, ConfigBatchData configBatchData)	Insert, update, or delete configuration entries.
ConfigResult	checkoutConfigurations(ClientInfo ci, ConfigInfo configInfo, ConfigResultOptions configResultOptions)	Read configuration entries.
void	deleteConfiguration(ClientInfo ci, long id)	Deletes a configuration entry.
ConfigResult	deleteConfiguration2(ClientInfo ci, DeleteConfigInfo deleteInfo)	Deletes configuration entries that match the criteria in deleteInfo.
void	deleteConfigurations(ClientInfo ci, List<Long> configIds)	Deletes a list of configuration entries.

Methods inherited from interface byps.BRemote

BRemote_getTargetId

Method Details

checkinConfigurations

ConfigResult checkinConfigurations(ClientInfo ci,
 List<ConfigRecord> configRecords)
                            throws byps.RemoteException

Insert or update configuration entries. To update an existing entry, supply a non-zero ConfigRecord.id or an existing tuple of ConfigRecord.packageName, ConfigRecord.component, ConfigRecord.key, ConfigRecord.level, ConfigRecord.groupId, and ConfigRecord.instanceId.

Parameters:

ci - ClientInfo object

configRecords - List of configuration entries

Returns:

Updated or inserted items as ConfigResult.writtenRecords.

Throws:

byps.RemoteException

checkinConfigurationsBatch

ConfigResult checkinConfigurationsBatch(ClientInfo ci,
 ConfigBatchData configBatchData)
                                 throws byps.RemoteException

Insert, update, or delete configuration entries.

Parameters:

ci - ClientInfo object

configBatchData - Specifies which entries to modify

Returns:

Updated or inserted items as ConfigResult.writtenRecords.

Throws:

byps.RemoteException

checkoutConfigurations

ConfigResult checkoutConfigurations(ClientInfo ci,
 ConfigInfo configInfo,
 ConfigResultOptions configResultOptions)
                             throws byps.RemoteException

Read configuration entries.

Parameters:

ci - ClientInfo object

configInfo - Criteria to select related entries

configResultOptions - Defines how to map entries in ConfigResult.configRecords

Returns:

Selected entries in ConfigResult.configRecords

Throws:

byps.RemoteException

deleteConfiguration

void deleteConfiguration(ClientInfo ci,
 long id)
                  throws byps.RemoteException

Deletes a configuration entry.

Parameters:

ci - ClientInfo object

id - Entry ID, relates to ConfigRecord.id

Throws:

byps.RemoteException

deleteConfigurations

void deleteConfigurations(ClientInfo ci,
 List<Long> configIds)
                   throws byps.RemoteException

Deletes a list of configuration entries.

Parameters:

ci - ClientInfo object

configIds - Entry IDs

Throws:

byps.RemoteException

deleteConfiguration2

ConfigResult deleteConfiguration2(ClientInfo ci,
 DeleteConfigInfo deleteInfo)
                           throws byps.RemoteException

Deletes configuration entries that match the criteria in deleteInfo.

Parameters:

ci - ClientInfo

deleteInfo - Specifies what to delete

Returns:

Empty ConfigResult

Throws:

byps.RemoteException

Since:

21.02.000.011