Package com.priint.pubserver.plannerapi.interfaces

Interface ParametersServiceLocal

public interface ParametersServiceLocal
Local interface for the Parameters service from the Planner API

  • Method Details

    • 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:

    • getParameters

      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:

    • 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:

    • setDocumentParameters

      List<Parameter> setDocumentParameters(String documentID, 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:

    • setPublicationParameters

      List<Parameter> setPublicationParameters(String publicationID, 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:

    • setParameters

      List<Parameter> setParameters(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: