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

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

All Implemented Interfaces:

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

public class MakeCallsFromList
extends AbstractOperationImpl<java.lang.Boolean,MakeCallsFromList>

Calls (dials in) all entries from the specified call list(s). You can pass in either; the name of a stored Call List, an ad-hoc Call List (i.e. a list or array of CallListContents), or both.

The operation will return an indication of whether it succeeded or not.

Since:

5.1.0.0.40

Nested Class Summary

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

Operation.Impact

Method Summary

void	addToManualDialList(CallListContents callDetails) Adds a new detail to the ad-hoc Call List.
void	addToManualDialList(CallListContents[] adhocCallArray) Adds an array of CallListContents to the ad-hoc Call List.
void	addToManualDialList(java.util.List<CallListContents> adhocCallList) Adds a List of CallListContents to the ad-hoc Call List.
CallListContents[]	getAdhocCallList() Gets the contents of the 'adhocCallList'.
Message	getAnnunciatorURIToPlay() Gets the URI of the Annunciator message to play to newly dialed in conferees.
java.lang.String	getCallListURI() Gets the URI for the Call List we've to find the contents of.
Operation.Impact	getImpact() Returns the impact of the operation.
MediaResourcePool	getMediaResourcePool() Get the MediaResourcePool
java.lang.String	getSecurityCode() Gets the security code.
java.lang.String	getUserCode() Deprecated. use getSecurityCode()
Verb	getVerb() This gets the verb that describes this operation.
void	setAnnunciatorURIToPlay(Message annunciatorURIToPlay) Sets the URI of the Annunciator message to play to newly dialed in conferees.
void	setCallListURI(java.lang.String callListURI) Sets the URI for the Call List we've to find the contents of.
void	setMediaResourcePool(MediaResourcePool mediaResourcePool) Set the MediaResourcePool
void	setSecurityCode(java.lang.String securityCode) Sets the security code.
void	setUserCode(java.lang.String securityCode) Deprecated. use setSecurityCode(String)
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

getAnnunciatorURIToPlay

public Message getAnnunciatorURIToPlay()

Gets the URI of the Annunciator message to play to newly dialed in conferees.

Returns:

the URI of the Annunciator message to play to newly dialed in conferees

Since:

5.1.0.0.40

setAnnunciatorURIToPlay

@Required
public void setAnnunciatorURIToPlay(Message annunciatorURIToPlay)

Sets the URI of the Annunciator message to play to newly dialed in conferees.

Parameters:

annunciatorURIToPlay - the URI of the Annunciator message to play to newly dialed in conferees

Since:

5.1.0.0.40

getUserCode

@Deprecated
public java.lang.String getUserCode()

Deprecated. use getSecurityCode()

gets the user code

Returns:

the user code

Since:

5.1.0.0.40

setUserCode

@Deprecated
public void setUserCode(java.lang.String securityCode)

Deprecated. use setSecurityCode(String)

Sets the user code

Parameters:

securityCode - the user code

Since:

5.1.0.0.40

getSecurityCode

public java.lang.String getSecurityCode()

Gets the security code.

Returns:

the security code

Since:

5.1.0.0.56

setSecurityCode

public void setSecurityCode(java.lang.String securityCode)

Sets the security code.

Parameters:

securityCode - the security code

Since:

5.1.0.0.56

getMediaResourcePool

public MediaResourcePool getMediaResourcePool()

Get the MediaResourcePool

Returns:

the MediaResourcePool

setMediaResourcePool

@Required
public void setMediaResourcePool(MediaResourcePool mediaResourcePool)

Set the MediaResourcePool

Parameters:

mediaResourcePool - the MediaResourcePool

getCallListURI

public java.lang.String getCallListURI()

Gets the URI for the Call List we've to find the contents of.

Returns:

the URI for the Call List we've to find the contents of.

Since:

5.1.0.0.40

setCallListURI

@ValuesDerivedFrom(value=CALL_LISTS_GET)
public void setCallListURI(java.lang.String callListURI)

Sets the URI for the Call List we've to find the contents of.

Parameters:

callListURI - the URI for the Call List we've to find the contents of

Since:

5.1.0.0.40

getAdhocCallList

public CallListContents[] getAdhocCallList()

Gets the contents of the 'adhocCallList'.

Returns:

the contents of the 'adhocCallList'

Since:

5.1.0.0.40

addToManualDialList

public void addToManualDialList(CallListContents[] adhocCallArray)

Adds an array of CallListContents to the ad-hoc Call List.

Parameters:

adhocCallArray - The array of CallListContents to add to the ad-hoc Call List

Since:

5.1.0.0.40

addToManualDialList

public void addToManualDialList(java.util.List<CallListContents> adhocCallList)

Adds a List of CallListContents to the ad-hoc Call List.

Parameters:

adhocCallList - The List of CallListContents to add to the ad-hoc Call List

Since:

5.1.0.0.40

addToManualDialList

public void addToManualDialList(CallListContents callDetails)

Adds a new detail to the ad-hoc Call List.

Parameters:

callDetails - The new CallListContents to add to the ad-hoc Call list

Since:

5.1.0.0.40

getImpact

public Operation.Impact getImpact()

Returns the impact of the operation.

Returns:

the impact.

Since:

5.1.0.0.40

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.40

toString

public java.lang.String toString()

Overrides:

toString in class AbstractOperationImpl<java.lang.Boolean,MakeCallsFromList>