Package com.priint.pubserver.plannerapi.interfaces

Interface ParameterDefinitionsServiceLocal

public interface ParameterDefinitionsServiceLocal

Local interface for the ParameterDefinitions service from the Planner API

Method Summary

Modifier and Type	Method	Description
int	addParameterDefinition(ParameterDefinition parameterDefinition)	Creates a new parameter definition
ServiceResult	deleteParameterDefinition(int id)	Deletes parameter definition at the specified ID
ParameterDefinition	getParameterDefinition(int id)	Returns definition of parameter at the specified ID
List<ParameterDefinition>	getParameterDefinitions(ParameterDefinitionsFilter filter)	Returns a list of parameter definitions fulfilling the search criteria
ParameterDefinition	setParameterDefinition(ParameterDefinition parameterDefinition)	Modifies an existing parameter definition

Method Details

getParameterDefinition

ParameterDefinition getParameterDefinition(int id)
                                    throws ServiceException

Returns definition of parameter at the specified ID

Parameters:

id - parameter definition ID

Returns:

parameter definition

Throws:

ServiceException

See Also:

• ParameterDefinition

getParameterDefinitions

List<ParameterDefinition> getParameterDefinitions(ParameterDefinitionsFilter filter)
                                           throws ServiceException

Returns a list of parameter definitions fulfilling the search criteria

Parameters:

filter - search criteria in ParameterDefinitionsFilter object

Returns:

List of parameter definitions

Throws:

ServiceException

See Also:

• ParameterDefinition
• ParameterDefinitionsFilter

addParameterDefinition

int addParameterDefinition(ParameterDefinition parameterDefinition)
                    throws ServiceException

Creates a new parameter definition

Parameters:

parameterDefinition -

Returns:

ID of created parameter definition

Throws:

ServiceException

See Also:

• ParameterDefinition

setParameterDefinition

ParameterDefinition setParameterDefinition(ParameterDefinition parameterDefinition)
                                    throws ServiceException

Modifies an existing parameter definition

Parameters:

parameterDefinition - parameter definition to modify

Returns:

Modified parameter definition

Throws:

ServiceException

See Also:

• ParameterDefinition

deleteParameterDefinition

ServiceResult deleteParameterDefinition(int id)
                                 throws ServiceException

Deletes parameter definition at the specified ID

Parameters:

id - ID of prameter definition

Returns:

Default result class

Throws:

ServiceException

See Also:

• ServiceResult