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

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<EndPoint,MakeCall>
      com.avaya.conferencing.api.acp.control.operations.MakeCall

All Implemented Interfaces:

EndPointProducingOperation<MakeCall>, Operation<EndPoint,MakeCall>, java.lang.Cloneable

public final class MakeCall
extends AbstractOperationImpl<EndPoint,MakeCall>
implements EndPointProducingOperation<MakeCall>

Dials out to a new EndPoint.

The operation will return the local EndPoint that is dialling out.

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.lang.String	getDestination() Getter for property 'destination'.
java.util.Map<java.lang.String,java.lang.Object>	getEndPointProperties() 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>	getEndPointStates() Gets the current EndPoint States.
Operation.Impact	getImpact() Returns the impact of the operation.
MediaResourcePool	getMediaResourcePool() Get the MediaResourcePool
java.lang.String	getSecretPIN() Gets the secretPIN value
java.lang.String	getUniqueParticpantIdentifier() Gets the uniqueParticpantIdentifier value
Verb	getVerb() This gets the verb that describes this operation.
boolean	getVoiceMailFilter() Gets the value of VoiceMailFilter flag
void	setDestination(java.lang.String destination) Setter for property 'destination'.
void	setEndPointProperty(java.lang.String noun, java.lang.Object value) Define properties of the EndPoint that the operation will make a "best-effort" to set once the EndPoint is available.
void	setEndPointStates(java.util.Set<State> states) Set the States for the EndPoints.
void	setMediaResourcePool(MediaResourcePool mediaResourcePool) Set the MediaResourcePool
void	setSecretPIN(java.lang.String secretPIN) Sets the secretPIN
void	setUniqueParticpantIdentifier(java.lang.String uniqueParticpantIdentifier) Sets the uniqueParticpantIdentifier
void	setVoiceMailFilter(boolean voiceMailFilter) Sets VoiceMailFilter flag that enables VoiceMailCallFlow

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

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

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

await, await, clone, get, get, isDone, isSubmitted, set

Method Detail

getDestination

public java.lang.String getDestination()

Getter for property 'destination'.

Returns:

Value for property 'destination'.

Since:

5.1.0.0.29

setDestination

@Required
public void setDestination(java.lang.String destination)

Setter for property 'destination'.

Parameters:

destination - Value to set for property 'destination'.

Since:

5.1.0.0.29

getMediaResourcePool

public MediaResourcePool getMediaResourcePool()

Get the MediaResourcePool

Returns:

the MediaResourcePool

setMediaResourcePool

public void setMediaResourcePool(MediaResourcePool mediaResourcePool)

Set the MediaResourcePool

Parameters:

mediaResourcePool - The MediaResourcePool

getUniqueParticpantIdentifier

public java.lang.String getUniqueParticpantIdentifier()

Gets the uniqueParticpantIdentifier value

Since:

5.2.0.0.2

setUniqueParticpantIdentifier

public void setUniqueParticpantIdentifier(java.lang.String uniqueParticpantIdentifier)

Sets the uniqueParticpantIdentifier

Parameters:

uniqueParticpantIdentifier - Value to set for uniqueParticpantIdentifier

Since:

5.2.0.0.2

getSecretPIN

public java.lang.String getSecretPIN()

Gets the secretPIN value

Since:

5.2.0.0.2

setSecretPIN

public void setSecretPIN(java.lang.String secretPIN)

Sets the secretPIN

Parameters:

secretPIN - Value to set for secretPIN

Since:

5.2.0.0.2

getVoiceMailFilter

public boolean getVoiceMailFilter()

Gets the value of VoiceMailFilter flag

Returns:

the Value of voiceMoiceFilter

setVoiceMailFilter

public void setVoiceMailFilter(boolean voiceMailFilter)

Sets VoiceMailFilter flag that enables VoiceMailCallFlow

Parameters:

voiceMailFilter - Value to set for voiceMailFilter

getEndPointProperties

public java.util.Map<java.lang.String,java.lang.Object> getEndPointProperties()

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.

Specified by:

getEndPointProperties in interface EndPointProducingOperation<MakeCall>

Returns:

the endPointProperties (type Map) of this Dialout object.

Since:

5.1.0.0.29

getEndPointStates

public java.util.Set<State> getEndPointStates()

Gets the current EndPoint States.

Specified by:

getEndPointStates in interface EndPointProducingOperation<MakeCall>

Returns:

the current EndPoint States.

Since:

5.1.0.0.29

setEndPointProperty

public void setEndPointProperty(java.lang.String noun,
                                java.lang.Object value)

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

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

Specified by:

setEndPointProperty in interface EndPointProducingOperation<MakeCall>

Parameters:

noun - The name of the property.

value - The value to make a "best-effort" to set it to.

Since:

5.1.0.0.29

setEndPointStates

public void setEndPointStates(java.util.Set<State> states)

Set the States for the EndPoints.

Specified by:

setEndPointStates in interface EndPointProducingOperation<MakeCall>

Parameters:

states - the States to set.

Since:

5.1.0.0.29

getImpact

public Operation.Impact getImpact()

Returns the impact of the operation.

Specified by:

getImpact in interface Operation<EndPoint,MakeCall>

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.

Specified by:

getVerb in interface Operation<EndPoint,MakeCall>

Returns:

the verb that describes the operation.

Since:

5.1.0.0.29