Package com.priint.pubserver.plannerapi.interfaces

Interface ParamDropDownValuesServiceLocal

public interface ParamDropDownValuesServiceLocal

Local interface for the ParamDropDownValues service from the Planner API

Method Summary

Modifier and Type	Method	Description
int	addParameterDropDownValue(Integer paramDropDownListID, ParamDropDownValue value)	Add a parameter drop down value for specified paramDropDownListID
List<ParamDropDownValue>	addParameterDropDownValues(Integer paramDropDownListID, List<ParamDropDownValue> values)	Add a parameter drop down values for specified paramDropDownListID
ServiceResult	deleteParameterDropDownValue(int id)	Deletes parameter drop down value at the specified ID
ParamDropDownValue	getParameterDropDownValueById(int id)	Returns the parameter drop down value at the specified ID
List<ParamDropDownValue>	getParameterDropDownValues(ParameterDropDownValueFilter filter)	Returns parameter drop down values fulfilling the search criteria
ParamDropDownValue	setParameterDropDownValue(ParamDropDownValue value)	Set a parameter drop down value for specified paramDropDownListID
List<ParamDropDownValue>	setParameterDropDownValues(List<ParamDropDownValue> values)	Set a parameter drop down values
List<ParamDropDownValue>	setParameterDropDownValuesSortOrder(Integer paramDropDownListID, List<ParamDropDownValue> values)	set a sort of parameter drop down values for specified paramDropDownListID

Method Details

getParameterDropDownValueById

ParamDropDownValue getParameterDropDownValueById(int id)
                                          throws PubServerException

Returns the parameter drop down value at the specified ID

Parameters:

id - dropdown value ID

Returns:

the DropDownValue

Throws:

PubServerException

See Also:

• ParamDropDownValue

getParameterDropDownValues

List<ParamDropDownValue> getParameterDropDownValues(ParameterDropDownValueFilter filter)
                                             throws ServiceException

Returns parameter drop down values fulfilling the search criteria

Parameters:

filter - search criteria in the ParameterDropDownValueFilter object

Returns:

the list of DropDown values

Throws:

ServiceException

See Also:

• ParameterDropDownValueFilter
• ParamDropDownValue

addParameterDropDownValues

List<ParamDropDownValue> addParameterDropDownValues(Integer paramDropDownListID,
 List<ParamDropDownValue> values)
                                             throws PubServerException

Add a parameter drop down values for specified paramDropDownListID

Parameters:

paramDropDownListID - ID of the dropdown value list

values - List of ParamDropDownValue to Add

Returns:

Added List of ParamDropDownValue

Throws:

ServiceException

PubServerException

See Also:

• ParamDropDownValue

addParameterDropDownValue

int addParameterDropDownValue(Integer paramDropDownListID,
 ParamDropDownValue value)
                       throws PubServerException

Add a parameter drop down value for specified paramDropDownListID

Parameters:

paramDropDownListID - ID of the dropdown value list

value - ParamDropDownValue to Add

Returns:

Added ParamDropDownValue ID

Throws:

ServiceException

PubServerException

See Also:

• ParamDropDownValue

setParameterDropDownValuesSortOrder

List<ParamDropDownValue> setParameterDropDownValuesSortOrder(Integer paramDropDownListID,
 List<ParamDropDownValue> values)
                                                      throws PubServerException

set a sort of parameter drop down values for specified paramDropDownListID

Parameters:

paramDropDownListID -

values - List of ParamDropDownValue (in new order), should contain all ParamDropDownValues which are children of paramDropDownListID

Returns:

sorted List of ParamDropDownValue

Throws:

PubServerException

See Also:

• ParamDropDownValue

deleteParameterDropDownValue

ServiceResult deleteParameterDropDownValue(int id)
                                    throws ServiceException

Deletes parameter drop down value at the specified ID

Parameters:

id - ID of parameter drop down value

Returns:

Default result class

Throws:

ServiceException

See Also:

• ServiceResult

setParameterDropDownValues

List<ParamDropDownValue> setParameterDropDownValues(List<ParamDropDownValue> values)
                                             throws ServiceException

Set a parameter drop down values

Parameters:

values - List of ParamDropDownValue to set

Returns:

List of ParamDropDownValue

Throws:

ServiceException

See Also:

• ParamDropDownValue

setParameterDropDownValue

ParamDropDownValue setParameterDropDownValue(ParamDropDownValue value)
                                      throws ServiceException

Set a parameter drop down value for specified paramDropDownListID

Parameters:

value - ParamDropDownValue to set

Returns:

List of ParamDropDownValue

Throws:

ServiceException

See Also:

• ParamDropDownValue