Package com.priint.pubserver.plannerapi.interfaces

Interface ParametersServiceLocal

public interface ParametersServiceLocal

Local interface for the Parameters service from the Planner API

Method Summary

Modifier and Type	Method	Description
Parameter	getParameterById(int id)	Returns the parameter at the specified ID
java.util.List<Parameter>	getParameters(ParametersFilter filter)	Returns parameters fulfilling the search criteria
java.util.List<Parameter>	setDocumentParameters(java.lang.String documentID, java.util.List<Parameter> parameters)	Modifies parameters to the specified document
Parameter	setParameter(Parameter parameter)	Modifies an existing parameter
java.util.List<Parameter>	setParameters(java.util.List<Parameter> parameters)	Modifies parameters
java.util.List<Parameter>	setPublicationParameters(java.lang.String publicationID, java.util.List<Parameter> parameters)	Modifies parameters to the specified document

Method Detail

getParameterById

Parameter getParameterById(int id)
                    throws PubServerException

Returns the parameter at the specified ID

Parameters:

id - Parameter ID

Returns:

the parameter

Throws:

PubServerException

See Also:

Parameter

getParameters

java.util.List<Parameter> getParameters(ParametersFilter filter)
                                 throws ServiceException

Returns parameters fulfilling the search criteria

Parameters:

filter - search criteria in the ParametersFilter object

Returns:

the list of parameters

Throws:

ServiceException

See Also:

Parameter

setParameter

Parameter setParameter(Parameter parameter)
                throws PubServerException

Modifies an existing parameter

Only fields: Value,Value2,Value3, ParamDropDownValueID, EntityID, EntityModel, RecordstringID can be changed.

Parameters:

parameter - a parameter to change

Returns:

modified parameter

Throws:

PubServerException

See Also:

Parameter

setDocumentParameters

java.util.List<Parameter> setDocumentParameters(java.lang.String documentID,
                                                java.util.List<Parameter> parameters)
                                         throws PubServerException

Modifies parameters to the specified document

Only fields: Value,Value2,Value3, ParamDropDownValueID, EntityID, EntityModel, RecordstringID can be changed.

Parameters:

documentID - document ID

parameters - the list of parameters to assign

Returns:

List of processed parameters. Each Parameter object from the list contains status code of the operation

Throws:

PubServerException

See Also:

Parameter

setPublicationParameters

java.util.List<Parameter> setPublicationParameters(java.lang.String publicationID,
                                                   java.util.List<Parameter> parameters)
                                            throws ServiceException

Modifies parameters to the specified document

Only fields: Value,Value2,Value3, ParamDropDownValueID, EntityID, EntityModel, RecordstringID can be changed.

Parameters:

publicationID - publication ID

parameters - the list of parameters to assign

Returns:

the list of processed parameters. Each Parameter object from the list contains status code of the operation

Throws:

ServiceException

See Also:

Parameter

setParameters

java.util.List<Parameter> setParameters(java.util.List<Parameter> parameters)
                                 throws ServiceException

Modifies parameters

Only fields: Value,Value2,Value3, ParamDropDownValueID, EntityID, EntityModel, RecordstringID can be changed.

Parameters:

parameters - List of parameters to modify

Returns:

the list of processed parameters. Each Parameter object from the list contains status code of the operation

Throws:

ServiceException

See Also:

Parameter