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

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.String,PlayAndCollect>
      com.avaya.conferencing.api.acp.control.operations.PlayAndCollect

All Implemented Interfaces:

Operation<java.lang.String,PlayAndCollect>, java.lang.Cloneable

public class PlayAndCollect
extends AbstractOperationImpl<java.lang.String,PlayAndCollect>

Plays a prompt to an EndPoint and waits for a response (DTMF string) from that EndPoint.

The operation will return the response from the EndPoint as a String.

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	getDtmfToMatch() Gets the DTMF string to match.
Operation.Impact	getImpact() Returns the impact of the operation.
int	getMaxDigits() Gets the maximum amount of DTMF digits expected in the response.
Message	getMessage() Gets the Message the operation is to play.
MessageSet	getMessageSet() Gets the MessageSet to use.
Message	getMessageToPlay() Deprecated. use getMessage()
int	getMinDigits() Gets the minimum amount of DTMF digits expected in the response.
Verb	getVerb() This gets the verb that describes this operation.
boolean	isDigitRangeSet() Tells whether either the max/min digits have been reset from the default values.
void	setDtmfToMatch(java.lang.String dtmfToMatch) Sets the DTMF string response that is expected.
void	setMaxDigits(int maxDigits) Sets the maximum amount of DTMF digits expected in the response.
void	setMessage(Message message) Sets the Message to play for the operation.
void	setMessageSet(MessageSet messageSet) Sets the MessageSet to use.
void	setMessageToPlay(Message messageToPlay) Deprecated. use setMessage(com.avaya.conferencing.api.acp.control.Message)
void	setMinDigits(int minDigits) Sets the minimum amount of DTMF digits expected in the response.

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

Method Detail

getMessageToPlay

@Deprecated
public Message getMessageToPlay()

Deprecated. use getMessage()

Gets the Message the operation is to play.

Returns:

the Message that is to be played.

Since:

5.1.0.0.29

setMessageToPlay

@Deprecated
public void setMessageToPlay(Message messageToPlay)

Deprecated. use setMessage(com.avaya.conferencing.api.acp.control.Message)

Sets the Message to play for the operation. The operation CANNOT be carried out without telling it which Message to play.

Parameters:

messageToPlay - The Message to play.

Since:

5.1.0.0.29

getMessage

public Message getMessage()

Gets the Message the operation is to play.

Returns:

the Message that is to be played.

Since:

5.1.0.0.56

setMessage

@Required
public void setMessage(Message message)

Sets the Message to play for the operation. This is a Required field. The operation CANNOT be carried out without telling it which Message to play.

Parameters:

message - The Message to play.

Since:

5.1.0.0.56

getMessageSet

public MessageSet getMessageSet()

Gets the MessageSet to use.

Returns:

the MessageSet to use.

Since:

5.1.0.0.29

setMessageSet

public void setMessageSet(MessageSet messageSet)

Sets the MessageSet to use.

Parameters:

messageSet - the MessageSet to use.

Since:

5.1.0.0.29

getDtmfToMatch

public java.lang.String getDtmfToMatch()

Gets the DTMF string to match.

Returns:

the DTMF string to match.

Since:

5.1.0.0.29

setDtmfToMatch

public void setDtmfToMatch(java.lang.String dtmfToMatch)

Sets the DTMF string response that is expected.

Parameters:

dtmfToMatch - the DTMF string to match.

Since:

5.1.0.0.29

getMinDigits

public int getMinDigits()

Gets the minimum amount of DTMF digits expected in the response.

Returns:

the minimum amount of digits.

Since:

5.1.0.0.29

setMinDigits

public void setMinDigits(int minDigits)

Sets the minimum amount of DTMF digits expected in the response.

Parameters:

minDigits - the minimum amount of digits.

Since:

5.1.0.0.29

getMaxDigits

public int getMaxDigits()

Gets the maximum amount of DTMF digits expected in the response.

Returns:

the maximum amount of digits.

Since:

5.1.0.0.29

setMaxDigits

public void setMaxDigits(int maxDigits)

Sets the maximum amount of DTMF digits expected in the response.

Parameters:

maxDigits - the maximum amount of digits.

Since:

5.1.0.0.29

isDigitRangeSet

public boolean isDigitRangeSet()

Tells whether either the max/min digits have been reset from the default values.

Returns:

whether the digits range has been reset.

Since:

5.1.0.0.30

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