com.cisco.jtapi.extensions
Interface CiscoTermEvFilter


public interface CiscoTermEvFilter

An application can use the CiscoTermEvFilter interface to selectively restrict those Terminal events that are not of interest.


Method Summary
 boolean getButtonPressedEnabled()
          Returns the event filter status of the CiscoTermButtonPressedEv event for the Terminal.
 boolean getDeviceDataEnabled()
          Returns the event filter status of the CiscoTermDataEv event for the Terminal.
 boolean getDeviceStateActiveEvFilter()
          Returns the event filter status of the CiscoTermDeviceStateActiveEv event for the Terminal.
 boolean getDeviceStateAlertingEvFilter()
          Returns the event filter status of the CiscoTermDeviceStateAlerting event for the Terminal.
 boolean getDeviceStateHeldEvFilter()
          Returns the event filter status of the CiscoTermDeviceStateHeldEv event for the Terminal.
 boolean getDeviceStateIdleEvFilter()
          Returns the CiscoTermDeviceStateIdleEv filter status.
 boolean getDeviceStateWhisperEvFilter()
          Returns the CiscoTermDeviceStateWhisperEv filter status
 boolean getDNDChangedEvFilter()
          Returns the CiscoTermDNDStatusChangedEv filter status
 boolean getDNDOptionChangedEvFilter()
          This interface can be used to get CiscoTermDNDOptionChangedEv filter status
 boolean getRTPEventsEnabled()
          Returns the event filter status of the CiscoRTPInputStartedEv, CiscoRTPOutputStartedEv, CiscoRTPInputStoppedEv, and CiscoRTPOutputStoppedEv events for the Terminal.
 boolean getRTPKeyEventsEnabled()
          Returns the event filter status of the CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv events for the Terminal.
 boolean getSnapshotEnabled()
          Returns the event filter status of the CiscoTermSnapshotEv and CiscoTermSnapshotCompletedEv events for the Terminal.
 void setButtonPressedEnabled(boolean enabled)
          Enables or disables CiscoTermButtonPressedEv events for the Terminal.
 void setDeviceDataEnabled(boolean enabled)
          Enables or disables the CiscoTermDataEv events for the Terminal.
 void setDeviceStateActiveEvFilter(boolean filterValue)
          Enables or disables the CiscoTermDeviceStateActiveEv filter for the Terminal.
 void setDeviceStateAlertingEvFilter(boolean filterValue)
          Enables or disables the CiscoTermDeviceStateAlertingEv filter for the Terminal.
 void setDeviceStateHeldEvFilter(boolean filterValue)
          Enables or disables the CiscoTermDeviceStateHeldEv filter for the Terminal.
 void setDeviceStateIdleEvFilter(boolean filterValue)
          Enables or disables the CiscoTermDeviceStateIdleEv filter for the Terminal.
 void setDeviceStateWhisperEvFilter(boolean filterValue)
          Enables or disables the CiscoTermDeviceStateWhisperEv filter for the Terminal.
 void setDNDChangedEvFilter(boolean filterValue)
          Enables or disables the CiscoTermDNDStatusChangedEv filter for the Terminal.
 void setDNDOptionChangedEvFilter(boolean filterValue)
          This interface is provided for enabling/disabling the CiscoTermDNDOptionChangedEv filter for the Terminal
 void setRTPEventsEnabled(boolean enabled)
          Enables or disables CiscoRTPInputStartedEv, CiscoRTPOutputStartedEv, CiscoRTPInputStoppedEv and CiscoRTPOutputStoppedEv events for the Terminal.
 void setRTPKeyEventsEnabled(boolean enabled)
          Enables or disables the CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv events for the Terminal.
 void setSnapshotEnabled(boolean enabled)
          Enable or disables CiscoTermSnapshotEv and CiscoTermSnapshotCompletedEv for the Terminal.
 

Method Detail

getDeviceDataEnabled

boolean getDeviceDataEnabled()
Returns the event filter status of the CiscoTermDataEv event for the Terminal. The default value is disabled.

Returns:
True if the event filter is enabled, or false if the event filter is disabled

setDeviceDataEnabled

void setDeviceDataEnabled(boolean enabled)
Enables or disables the CiscoTermDataEv events for the Terminal.


getButtonPressedEnabled

boolean getButtonPressedEnabled()
Returns the event filter status of the CiscoTermButtonPressedEv event for the Terminal. The default value is disabled.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

setButtonPressedEnabled

void setButtonPressedEnabled(boolean enabled)
Enables or disables CiscoTermButtonPressedEv events for the Terminal.


getRTPEventsEnabled

boolean getRTPEventsEnabled()
Returns the event filter status of the CiscoRTPInputStartedEv, CiscoRTPOutputStartedEv, CiscoRTPInputStoppedEv, and CiscoRTPOutputStoppedEv events for the Terminal. The Default value is disabled.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

setRTPEventsEnabled

void setRTPEventsEnabled(boolean enabled)
Enables or disables CiscoRTPInputStartedEv, CiscoRTPOutputStartedEv, CiscoRTPInputStoppedEv and CiscoRTPOutputStoppedEv events for the Terminal.


getSnapshotEnabled

boolean getSnapshotEnabled()
Returns the event filter status of the CiscoTermSnapshotEv and CiscoTermSnapshotCompletedEv events for the Terminal. If disabled, neither event gets sent to applications.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

setSnapshotEnabled

void setSnapshotEnabled(boolean enabled)
Enable or disables CiscoTermSnapshotEv and CiscoTermSnapshotCompletedEv for the Terminal.


getRTPKeyEventsEnabled

boolean getRTPKeyEventsEnabled()
Returns the event filter status of the CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv events for the Terminal.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

setRTPKeyEventsEnabled

void setRTPKeyEventsEnabled(boolean enabled)
Enables or disables the CiscoRTPInputKeyEv and CiscoRTPOutputKeyEv events for the Terminal.


getDeviceStateActiveEvFilter

boolean getDeviceStateActiveEvFilter()
Returns the event filter status of the CiscoTermDeviceStateActiveEv event for the Terminal.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

getDeviceStateHeldEvFilter

boolean getDeviceStateHeldEvFilter()
Returns the event filter status of the CiscoTermDeviceStateHeldEv event for the Terminal.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

getDeviceStateAlertingEvFilter

boolean getDeviceStateAlertingEvFilter()
Returns the event filter status of the CiscoTermDeviceStateAlerting event for the Terminal.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

getDeviceStateIdleEvFilter

boolean getDeviceStateIdleEvFilter()
Returns the CiscoTermDeviceStateIdleEv filter status.

Returns:
True if the event filter is enabled, or false if the event filter is disabled.

setDeviceStateActiveEvFilter

void setDeviceStateActiveEvFilter(boolean filterValue)
Enables or disables the CiscoTermDeviceStateActiveEv filter for the Terminal. Default value is disable


setDeviceStateHeldEvFilter

void setDeviceStateHeldEvFilter(boolean filterValue)
Enables or disables the CiscoTermDeviceStateHeldEv filter for the Terminal. Default value is disable


setDeviceStateAlertingEvFilter

void setDeviceStateAlertingEvFilter(boolean filterValue)
Enables or disables the CiscoTermDeviceStateAlertingEv filter for the Terminal. Default value is disable


setDeviceStateIdleEvFilter

void setDeviceStateIdleEvFilter(boolean filterValue)
Enables or disables the CiscoTermDeviceStateIdleEv filter for the Terminal. Default value is disable


getDeviceStateWhisperEvFilter

boolean getDeviceStateWhisperEvFilter()
Returns the CiscoTermDeviceStateWhisperEv filter status

Returns:
boolean CiscoTermDeviceStateWhisperEv Filter status on the Terminal.

getDNDChangedEvFilter

boolean getDNDChangedEvFilter()
Returns the CiscoTermDNDStatusChangedEv filter status

Returns:
the CiscoTermDNDStatusChangedEv Filter status on the Terminal.

setDNDChangedEvFilter

void setDNDChangedEvFilter(boolean filterValue)
Enables or disables the CiscoTermDNDStatusChangedEv filter for the Terminal.

Parameters:
filterValue -

setDeviceStateWhisperEvFilter

void setDeviceStateWhisperEvFilter(boolean filterValue)
Enables or disables the CiscoTermDeviceStateWhisperEv filter for the Terminal. The default value is disable.


getDNDOptionChangedEvFilter

boolean getDNDOptionChangedEvFilter()
This interface can be used to get CiscoTermDNDOptionChangedEv filter status

Returns:
the CiscoTermDNDOptionChangedEv Filter status on the Terminal

setDNDOptionChangedEvFilter

void setDNDOptionChangedEvFilter(boolean filterValue)
This interface is provided for enabling/disabling the CiscoTermDNDOptionChangedEv filter for the Terminal

Parameters:
filterValue -