Interface LiferayMutablePortletParameters

All Superinterfaces:
jakarta.portlet.Mutable, jakarta.portlet.MutablePortletParameters, jakarta.portlet.PortletParameters
All Known Subinterfaces:
LiferayMutableRenderParameters
All Known Implementing Classes:
BaseMutablePortletParameters, MutableActionParametersImpl, MutableRenderParametersImpl, MutableResourceParametersImpl

public interface LiferayMutablePortletParameters extends jakarta.portlet.MutablePortletParameters
Author:
Neil Griffin
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns true if the state of the portlet parameters has changed.
    setValue(String name, String value, boolean append)
    Sets the parameter value.
    setValues(String name, String[] values, boolean append)
    Sets the parameter values.

    Methods inherited from interface jakarta.portlet.MutablePortletParameters

    add, clear, getNames, removeParameter, set, setValue, setValues

    Methods inherited from interface jakarta.portlet.PortletParameters

    clone, getValue, getValues, isEmpty, size
  • Field Details

  • Method Details

    • isMutated

      boolean isMutated()
      Returns true if the state of the portlet parameters has changed.
      Returns:
      true if the state has changed; false otherwise
    • setValue

      String setValue(String name, String value, boolean append)
      Sets the parameter value. An IllegalArgumentException is thrown if the name is null.
      Parameters:
      name - the parameter's name
      value - the parameter's value. If null, the parameter is removed.
      append - whether the new value is appended to any existing values for the parameter. If this is false, any existing values are overwritten with the new value.
      Returns:
      the parameter value prior to setting
    • setValues

      String[] setValues(String name, String[] values, boolean append)
      Sets the parameter values. An IllegalArgumentException is thrown if the name is null.
      Parameters:
      name - the parameter's name
      values - the parameter's values. If null, the parameter is removed.
      append - whether the new values are appended to any existing values for the parameter. If this is false, any existing values are overwritten with the new values.
      Returns:
      the parameter values prior to setting