.. java:import:: org.json JSONObject

PinConstraint
=============

.. java:package:: com.idopte.scmapi
   :noindex:

.. java:type:: public class PinConstraint

   Class describes the format constraints of the PIN (which must be enforced when changing the PIN value).

   Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.

   The constraints are obtained as an array of \ :java:ref:`PinConstraint`\  objects by calling \ :java:ref:`Pin.getConstraints()`\ .

   The objects \ :java:ref:`PinConstraint`\  describing a constraint all have a ``type``, indicating the type of constraints, and optionally, the parameters of the constraint. The ``type`` and ``parameters`` value can be one of the following (this list may be extended in the future):

   +------------------------+-----------------+
   | ``"minLength"``        | ``"minLength"`` |
   +------------------------+-----------------+
   | ``"newOldDissimilar"`` | ``"threshold"`` |
   +------------------------+-----------------+

Methods
-------
getParameter
^^^^^^^^^^^^

.. java:method:: public Object getParameter(String parameter)
   :outertype: PinConstraint

   Gets the parameters of the constraint.

   :param parameter: the parameter name to get value from
   :return: the parameters of the constraint, or ``null`` if the constraint has no parameters.

getType
^^^^^^^

.. java:method:: public String getType()
   :outertype: PinConstraint

   Gets the type of the constraint.

   :return: the type of the constraint.