=================
ConfigurationRule
=================

.. py:currentmodule:: p3dsdk

.. py:class:: ConfigurationRule


   .. py:method:: id
      :property:

      The id of the rule.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the rule.

      :type: str
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: expression
      :property:

      The expression of the rule.

      :type: str
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: enabled
      :property:

      The enable state of the rule.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: list_targets()

      List all the :py:obj:`ConfigurationTarget`.


      :returns: The list of :py:obj:`ConfigurationTarget` in this rule.
      :rtype: list(ConfigurationTarget)


   .. py:method:: create_target(layer_id)

      Create a new :py:obj:`ConfigurationTarget` in this rule.

      :param layer_id: Id of the layer targeted.
      :type layer_id: str

      :returns: The newly created :py:obj:`ConfigurationTarget`.
      :rtype: ConfigurationTarget

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: remove()

      Delete this rule.



      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.