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

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

All Implemented Interfaces:

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

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

Sets the contents of a Call list on the ConferencingProvider. This will effectively remove a call list if there are no contents passed in.

The operation will return a URI for the resulting Call List (obviously, this will be empty where the action results in the removal of the Call list).

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	addToCallListContents(CallListContents callDetails) Adds a new detail to the Call List.
void	addToCallListContents(CallListContents[] callListContents) Sets the contents of the Call List.
void	addToCallListContents(java.util.List<CallListContents> callListContents) Sets the contents of the Call List.
CallListContents[]	getCallListContents() Gets the contents of the Call List.
java.lang.String	getCallListURI() Gets the URI of the Call List we're creating/modifying.
Operation.Impact	getImpact() Returns the impact of the operation.
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	setCallListURI(java.lang.String callListURI) Sets the URI of the Call List we're creating/modifying.
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

getCallListURI

public java.lang.String getCallListURI()

Gets the URI of the Call List we're creating/modifying.

Returns:

the name of the Call List we're creating/modifying

Since:

5.1.0.0.40

setCallListURI

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

Sets the URI of the Call List we're creating/modifying.

Parameters:

callListURI - the name of the Call List we're creating/modifying

Since:

5.1.0.0.40

getUserCode

@Deprecated
public java.lang.String getUserCode()

Deprecated. use getSecurityCode()

gets the user code

Returns:

the user code

setUserCode

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

Deprecated. use setSecurityCode(String)

Sets the user code

Parameters:

securityCode - the user code

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. If no security code is supplied, then the participants will be directly dialled in to the conference.

Parameters:

securityCode - the security code

Since:

5.1.0.0.56

getCallListContents

public CallListContents[] getCallListContents()

Gets the contents of the Call List.

Returns:

the contents of the Call List

Since:

5.1.0.0.40

addToCallListContents

public void addToCallListContents(CallListContents[] callListContents)

Sets the contents of the Call List.

Parameters:

callListContents - New contents of the Call List

Since:

5.1.0.0.40

addToCallListContents

public void addToCallListContents(java.util.List<CallListContents> callListContents)

Sets the contents of the Call List.

Parameters:

callListContents - New contents of the Call List

Since:

5.1.0.0.40

addToCallListContents

public void addToCallListContents(CallListContents callDetails)

Adds a new detail to the Call List.

Parameters:

callDetails - The new CallListContents to add to the 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.String,CallListSet>