com.tibco.cep.runtime.model.element

## Interface PropertyAtomBoolean

-     public interface PropertyAtomBoolean

  Property that contains one boolean value.
  Since:
    2.0.0

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `getBoolean()` Gets the current boolean value of this `PropertyAtom`.
    `boolean` | `getBoolean(long time)` Gets the boolean value that this `PropertyAtom` had at the given time.
    `boolean` | `getBooleanAtIdx(int idx)` Gets the boolean value of this `PropertyAtom` at the given history index.
    `boolean` | `setBoolean(boolean value)` Sets the current value of this `PropertyAtom`.
    `boolean` | `setBoolean(boolean value, long time)` Sets the value of this `PropertyAtom` with a given time.

- - ### Method Detail

    - #### getBoolean

          boolean getBoolean()

      Gets the current boolean value of this `PropertyAtom`.
      Returns:
        the value of this `PropertyAtom`.
      Since:
        2.0.0

    - #### getBoolean

          boolean getBoolean(long time)

      Gets the boolean value that this `PropertyAtom` had at the given time.
      Parameters:
        `time` - a time expressed in number of milliseconds since the epoch.
      Returns:
        a boolean value.
      Throws:
        `PropertyException` - if the value at the given time is unknown.
      Since:
        2.0.0

    - #### getBooleanAtIdx

          boolean getBooleanAtIdx(int idx)

      Gets the boolean value of this `PropertyAtom` at the given history index.
      Parameters:
        `idx` - index in the history of this property.
      Returns:
        the boolean value of this property at the given index.
      Throws:
        `PropertyException` - if the index is invalid.
      Since:
        2.0.0
      See Also:
        `Property#getHistoryPolicy()`, `Property#getHistorySize()`

    - #### setBoolean

          boolean setBoolean(boolean value)

      Sets the current value of this `PropertyAtom`.
      Parameters:
        `value` - the value to set
      Returns:
        true if a new entry was added in the history for this value.
      Since:
        2.0.0
      See Also:
        `Property#getHistoryPolicy()`

    - #### setBoolean

          boolean setBoolean(boolean value,
                             long time)

      Sets the value of this `PropertyAtom` with a given time.
      Parameters:
        `value` - the value to set.
        `time` - the time to associate with the value.
      Returns:
        true if a new entry was added in the history for this value.
      Since:
        2.0.0
      See Also:
        `Property#getHistoryPolicy()`