org.bonitasoft.engine.parameter

Class ParameterServiceImpl

java.lang.Object

org.bonitasoft.engine.parameter.ParameterServiceImpl

All Implemented Interfaces:

ParameterService

public class ParameterServiceImpl
extends java.lang.Object
implements ParameterService

Author:

Baptiste Mesta

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE
static java.lang.String	PARAMETER

Constructor Summary

Constructors

Constructor and Description
ParameterServiceImpl(Recorder recorder, ReadPersistenceService persistenceService, TechnicalLoggerService technicalLoggerService)

Method Summary

Modifier and Type	Method and Description
void	addAll(long processDefinitionId, java.util.Map<java.lang.String,java.lang.String> parameters) Store all parameters provided to the specific process in file system
boolean	containsNullValues(long processDefinitionId) Check if the specific process contains null-valued parameter or not.
void	deleteAll(long processDefinitionId) Delete all parameters for a specific processDefinition
java.util.List<SParameter>	get(long processDefinitionId, int fromIndex, int numberOfResult, OrderBy order) Get parameters in a specific interval for specific process, this is used for pagination
SParameter	get(long processDefinitionId, java.lang.String parameterName) Get parameter by name in specific process
java.util.Map<java.lang.String,java.lang.String>	getAll(long processDefinitionId) return all parameters in a map
java.util.List<SParameter>	getNullValues(long processDefinitionId, int fromIndex, int numberOfResult, OrderBy order) Get a list of parameters will null values in order in specific process
protected java.lang.String	interpretParameterValue(java.lang.String s) Handle null values.
void	merge(long processDefinitionId, java.util.Map<java.lang.String,java.lang.String> parameters) Merge given parameters with existing ones.
void	update(long processDefinitionId, java.lang.String parameterName, java.lang.String parameterValue) Update specific parameter value in a process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PAGE_SIZE

public static final int PAGE_SIZE

See Also:

Constant Field Values

PARAMETER

public static final java.lang.String PARAMETER

See Also:

Constant Field Values

Constructor Detail

ParameterServiceImpl

public ParameterServiceImpl(Recorder recorder,
                            ReadPersistenceService persistenceService,
                            TechnicalLoggerService technicalLoggerService)

Method Detail

update

public void update(long processDefinitionId,
                   java.lang.String parameterName,
                   java.lang.String parameterValue)
            throws SParameterNameNotFoundException,
                   SBonitaReadException,
                   SObjectModificationException

Description copied from interface: ParameterService

Update specific parameter value in a process

Specified by:

update in interface ParameterService

Parameters:

processDefinitionId - identifier of processDefinition

parameterName - name of the parameter will be updated

parameterValue - new value of the parameter

Throws:

SParameterNameNotFoundException - error thrown if no parameter found for the specific parameterName

SBonitaReadException

SObjectModificationException

merge

public void merge(long processDefinitionId,
                  java.util.Map<java.lang.String,java.lang.String> parameters)
           throws SBonitaReadException,
                  SObjectModificationException

Description copied from interface: ParameterService

Merge given parameters with existing ones. Unknown parameters are ignored.

Specified by:

merge in interface ParameterService

Parameters:

processDefinitionId - identifier of processDefinition

parameters - parameters to merge

Throws:

SBonitaReadException - error thrown if an error occured while retrieving the process definition

SObjectModificationException - error thrown if an error occured while updating the parameter value

interpretParameterValue

protected java.lang.String interpretParameterValue(java.lang.String s)

Handle null values. If input is ParameterContribution.NULL, convert it to null

addAll

public void addAll(long processDefinitionId,
                   java.util.Map<java.lang.String,java.lang.String> parameters)
            throws SObjectCreationException,
                   SBonitaReadException,
                   SObjectModificationException

Description copied from interface: ParameterService

Store all parameters provided to the specific process in file system

Specified by:

addAll in interface ParameterService

Parameters:

processDefinitionId - identifier of processDefinition

parameters - parameters will be stored in file system

Throws:

SObjectCreationException

SBonitaReadException

SObjectModificationException

getAll

public java.util.Map<java.lang.String,java.lang.String> getAll(long processDefinitionId)
                                                        throws SParameterProcessNotFoundException,
                                                               SBonitaReadException

Description copied from interface: ParameterService

return all parameters in a map

Specified by:

getAll in interface ParameterService

Throws:

SParameterProcessNotFoundException

SBonitaReadException

deleteAll

public void deleteAll(long processDefinitionId)
               throws SParameterProcessNotFoundException,
                      SBonitaReadException,
                      SObjectModificationException

Description copied from interface: ParameterService

Delete all parameters for a specific processDefinition

Specified by:

deleteAll in interface ParameterService

Parameters:

processDefinitionId - ID of processDefinition

Throws:

SParameterProcessNotFoundException - error thrown if no parameters configuration file found in file system

SBonitaReadException

SObjectModificationException

get

public java.util.List<SParameter> get(long processDefinitionId,
                                      int fromIndex,
                                      int numberOfResult,
                                      OrderBy order)
                               throws SBonitaReadException

Description copied from interface: ParameterService

Get parameters in a specific interval for specific process, this is used for pagination

Specified by:

get in interface ParameterService

Parameters:

processDefinitionId - identifier of processDefinition

fromIndex - index of the record to be retrieved from. First record has index 0

numberOfResult - number of result we want to get. Maximum number of result returned.

order - OrderBy object, contains information to do order

Returns:

a list of SParameter objects

Throws:

SBonitaReadException

get

public SParameter get(long processDefinitionId,
                      java.lang.String parameterName)
               throws SBonitaReadException

Description copied from interface: ParameterService

Get parameter by name in specific process

Specified by:

get in interface ParameterService

Parameters:

processDefinitionId - identifier of processDefinition

parameterName - name of parameter

Returns:

the parameter or null if it does not exists

Throws:

SBonitaReadException

getNullValues

public java.util.List<SParameter> getNullValues(long processDefinitionId,
                                                int fromIndex,
                                                int numberOfResult,
                                                OrderBy order)
                                         throws SParameterProcessNotFoundException,
                                                SBonitaReadException

Description copied from interface: ParameterService

Get a list of parameters will null values in order in specific process

Specified by:

getNullValues in interface ParameterService

Parameters:

processDefinitionId - identifier of processDefinition

fromIndex - index of the record to be retrieved from. First record has index 0

numberOfResult - number of result we want to get. Maximum number of result returned.

order - OrderBy object, contains information to do order

Returns:

a list of parameters

Throws:

SParameterProcessNotFoundException - error thrown if no parameters configuration file found in file system

SBonitaReadException

containsNullValues

public boolean containsNullValues(long processDefinitionId)
                           throws SBonitaReadException

Description copied from interface: ParameterService

Check if the specific process contains null-valued parameter or not.

Specified by:

containsNullValues in interface ParameterService

Parameters:

processDefinitionId - The ID of the process definition

Returns:

true if at least one parameter contains a null value, false otherwise.

Throws:

SBonitaReadException