Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control.operations
Class PollingModeStart

java.lang.Object
  extended by com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.Boolean,PollingModeStart>
      extended by com.avaya.conferencing.api.acp.control.operations.PollingModeStart
All Implemented Interfaces:
Operation<java.lang.Boolean,PollingModeStart>, java.lang.Cloneable

public final class PollingModeStart
extends AbstractOperationImpl<java.lang.Boolean,PollingModeStart>

This command operates on a Conference. It places the Conference into a polling state. This can only be done by an Operator with an audio path established.

The result of this operation tells whether the conference was successfully placed into the poling state

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
 
Method Summary
 Operation.Impact getImpact()
          Returns the impact of the operation.
 Verb getVerb()
          This gets the verb that describes this operation.
 java.lang.Boolean isIncludeAll()
          Getter for property 'includeAll'.
 void setIncludeAll(java.lang.Boolean includeAll)
          Setter for property 'includeAll'.
 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
 

Method Detail

isIncludeAll

public java.lang.Boolean isIncludeAll()
Getter for property 'includeAll'.

Returns:
Value for property 'includeAll'.
Since:
5.1.0.0.29

setIncludeAll

@Required
public void setIncludeAll(java.lang.Boolean includeAll)
Setter for property 'includeAll'.

Parameters:
includeAll - Value to set for property 'destination'.
Since:
5.1.0.0.29

toString

public java.lang.String toString()

Overrides:
toString in class AbstractOperationImpl<java.lang.Boolean,PollingModeStart>
Since:
5.1.0.0.29

getImpact

public Operation.Impact getImpact()
Returns the impact of the operation.

Returns:
the impact.
Since:
5.1.0.0.29

getVerb

public Verb getVerb()
This gets the verb that describes this operation. Multiple operations may return the same verb, however verbs must be unique across the preferred operations. That is only one prefered operation may implement the "mute" verb. There may be deprecated operations that implement the "mute" verb but these will be less performant as they will be implemented as wrappers for the preferred "mute" operation.

Returns:
the verb that describes the operation.
Since:
5.1.0.0.29

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.