com.avaya.conferencing.api.acp.control.operations
Class StateChangingOperation<T extends StateChangingOperation<T>>

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.Boolean,T>
      com.avaya.conferencing.api.acp.control.operations.StateChangingOperation<T>

Type Parameters:

T - type parameter corresponding to the non-abstract class that is implementing a StateChangingOperation.

All Implemented Interfaces:

Operation<java.lang.Boolean,T>, java.lang.Cloneable

Direct Known Subclasses:

Access, AutomaticGainControlMode, ConferencingProviderLink, DTMFPassthrough, DTMFRegeneration, Fault, Hold, LectureMode, MeasureDTMFSignalToNoiseRatio, Moderator, ModeratorDisconnectMode, Mute, Observe, ProtectDetails, SecuredMode, SecurityFeatures, Silence

public abstract class StateChangingOperation<T extends StateChangingOperation<T>>
extends AbstractOperationImpl<java.lang.Boolean,T>

A state changing operation.

Since:

5.1.0.0.29

Nested Class Summary

Nested classes/interfaces inherited from interface com.avaya.conferencing.api.acp.control.operations.Operation

Operation.Impact

Constructor Summary

StateChangingOperation()

Method Summary

Operation.Impact	getImpact() Returns the impact of the operation.
StateChange	getMode() Getter for property 'mode'.
abstract State	getState() Returns the state that is affected by this StateChangingOperation.
T	off() Makes this state change operation turn off the state.
T	on() Makes this state change operation turn on the state.
void	setMode(StateChange mode) Setter for property 'mode'.
T	toggle() Makes this state change operation toggle the state.
java.lang.String	toString()

Methods inherited from class com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl

await, await, checkNotSubmitted, checkSubmitted, clone, get, get, isDone, isSubmitted, set

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.avaya.conferencing.api.acp.control.operations.Operation

getVerb

Constructor Detail

StateChangingOperation

public StateChangingOperation()

Method Detail

getMode

public final StateChange getMode()

Getter for property 'mode'.

Returns:

Value for property 'mode'.

Since:

5.1.0.0.29

setMode

public final void setMode(StateChange mode)

Setter for property 'mode'.

Parameters:

mode - Value to set for property 'mode'.

Since:

5.1.0.0.29

toString

public java.lang.String toString()

Overrides:

toString in class AbstractOperationImpl<java.lang.Boolean,T extends StateChangingOperation<T>>

Since:

5.1.0.0.29

getImpact

public final Operation.Impact getImpact()

Returns the impact of the operation.

Returns:

the impact.

Since:

5.1.0.0.29

getState

public abstract State getState()

Returns the state that is affected by this StateChangingOperation.

Returns:

The state that is affected by this StateChangingOperation.

Since:

5.1.0.0.29

off

public final T off()

Makes this state change operation turn off the state.

Returns:

this for method chaining.

Since:

5.1.0.0.29

on

public final T on()

Makes this state change operation turn on the state.

Returns:

this for method chaining.

Since:

5.1.0.0.29

toggle

public final T toggle()

Makes this state change operation toggle the state.

Returns:

this for method chaining.

Since:

5.1.0.0.29