Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control.operations
Interface ConferenceProducingOperation<IMPL extends Operation<Conference,IMPL>>

All Superinterfaces:
java.lang.Cloneable, Operation<Conference,IMPL>
All Known Implementing Classes:
Create

public interface ConferenceProducingOperation<IMPL extends Operation<Conference,IMPL>>
extends Operation<Conference,IMPL>

An operation that results in a Conference instance, for example creating a conference.

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
 java.util.Map<java.lang.String,java.lang.Object> getConferenceProperties()
          Returns the current properties for the EndPoint that the operation should make a "best-effort" to set once the EndPoint is available.
 java.util.Set<State> getConferenceStates()
          Returns the current states for the Conference that the operation should make a "best-effort" to apply once the Conference is available.
 void setConferenceProperty(java.lang.String property, java.lang.Object value)
          Define properties of the Conference that the operation will make a "best-effort" to set once the Conference is available.

 void setConferenceStates(java.util.Set<State> states)
          Define states of the EndPoint that the operation will make a "best-effort" to apply once the EndPoint is available.
 
Methods inherited from interface com.avaya.conferencing.api.acp.control.operations.Operation
await, await, clone, get, get, getImpact, getVerb, isDone, isSubmitted, set
 

Method Detail

getConferenceProperties

java.util.Map<java.lang.String,java.lang.Object> getConferenceProperties()
Returns the current properties for the EndPoint that the operation should make a "best-effort" to set once the EndPoint is available. This should be a read-only copy made at the time of the call.

Returns:
the conferenceProperties (type Map) of this Dialout object.
Since:
5.1.0.0.34

getConferenceStates

java.util.Set<State> getConferenceStates()
Returns the current states for the Conference that the operation should make a "best-effort" to apply once the Conference is available. This should be a read-only copy made at the time of the call.

Returns:
the conferenceProperties (type Map) of this Dialout object.
Since:
5.1.0.0.34

setConferenceProperty

void setConferenceProperty(java.lang.String property,
                           java.lang.Object value)

Define properties of the Conference that the operation will make a "best-effort" to set once the Conference is available.

"Best-effort" implies that failures will be silently ignored.

Parameters:
property - The name of the property.
value - The value to make a "best-effort" to set it to.
Since:
5.1.0.0.34

setConferenceStates

void setConferenceStates(java.util.Set<State> states)
Define states of the EndPoint that the operation will make a "best-effort" to apply once the EndPoint is available.

"Best-effort" implies that failures will be silently ignored.

Parameters:
states - The set of states to make a "best-effort" to apply to the EndPoint.

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.