org.bonitasoft.engine.parameter

Class ParameterServiceImpl

java.lang.Object

org.bonitasoft.engine.parameter.ParameterServiceImpl

All Implemented Interfaces:

ParameterService

public class ParameterServiceImpl
extends Object
implements ParameterService

Author:

Baptiste Mesta

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE
static String	PARAMETER

Constructor Summary

Constructors

Constructor and Description
ParameterServiceImpl(Recorder recorder, org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService, EventService eventService)

Method Summary

Modifier and Type	Method and Description
void	addAll(long processDefinitionId, Map<String,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
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, String parameterName) Get parameter by name in specific process
Map<String,String>	getAll(long processDefinitionId) return all parameters in a map
List<SParameter>	getNullValues(long processDefinitionId, int fromIndex, int numberOfResult, OrderBy order) Get a list of parameters will null values in order in specific process
void	update(long processDefinitionId, String parameterName, 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 String PARAMETER

See Also:

Constant Field Values

Constructor Detail

ParameterServiceImpl

public ParameterServiceImpl(Recorder recorder,
                            org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService,
                            EventService eventService)

Method Detail

update

public void update(long processDefinitionId,
                   String parameterName,
                   String parameterValue)
            throws SParameterNameNotFoundException,
                   org.bonitasoft.engine.persistence.SBonitaReadException,
                   org.bonitasoft.engine.commons.exceptions.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

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

addAll

public void addAll(long processDefinitionId,
                   Map<String,String> parameters)
            throws org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
                   org.bonitasoft.engine.persistence.SBonitaReadException,
                   org.bonitasoft.engine.commons.exceptions.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:

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

getAll

public Map<String,String> getAll(long processDefinitionId)
                          throws SParameterProcessNotFoundException,
                                 org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: ParameterService

return all parameters in a map

Specified by:

getAll in interface ParameterService

Throws:

SParameterProcessNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

deleteAll

public void deleteAll(long processDefinitionId)
               throws SParameterProcessNotFoundException,
                      org.bonitasoft.engine.persistence.SBonitaReadException,
                      org.bonitasoft.engine.commons.exceptions.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

org.bonitasoft.engine.persistence.SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

get

public List<SParameter> get(long processDefinitionId,
                            int fromIndex,
                            int numberOfResult,
                            OrderBy order)
                     throws org.bonitasoft.engine.persistence.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:

org.bonitasoft.engine.persistence.SBonitaReadException

get

public SParameter get(long processDefinitionId,
                      String parameterName)
               throws org.bonitasoft.engine.persistence.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:

org.bonitasoft.engine.persistence.SBonitaReadException

getNullValues

public List<SParameter> getNullValues(long processDefinitionId,
                                      int fromIndex,
                                      int numberOfResult,
                                      OrderBy order)
                               throws SParameterProcessNotFoundException,
                                      org.bonitasoft.engine.persistence.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

org.bonitasoft.engine.persistence.SBonitaReadException

containsNullValues

public boolean containsNullValues(long processDefinitionId)
                           throws org.bonitasoft.engine.persistence.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:

org.bonitasoft.engine.persistence.SBonitaReadException