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

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<Conference,Create>
      com.avaya.conferencing.api.acp.control.operations.Create

All Implemented Interfaces:

ConferenceProducingOperation<Create>, Operation<Conference,Create>, java.lang.Cloneable

public final class Create
extends AbstractOperationImpl<Conference,Create>
implements ConferenceProducingOperation<Create>

Opens a new Ad-hoc Conference.

The operation will return the Conference.

Since:

5.1.0.0.34

Nested Class Summary

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

Operation.Impact

Method Summary

void	addNumberToDial(java.lang.String numberToDial) Adds a number to the List of numbers to be dialed into the Conference
void	addToEndPointList(EndPoint endPoint) Adds an EndPoint to the list that will be pre-populated into the Conference
java.lang.String	getConferenceName() Gets the name that has been requested for the Conference
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() Gets the States to apply to the Conference.
EndPoint[]	getEndPointList() Gets an array of the EndPoint instances that will be pre-populated into the Conference.
Operation.Impact	getImpact() Returns the impact of the operation.
java.lang.String[]	getNumbersToDial() Gets an array (of Strings) of numbers to dial into the Conference.
Verb	getVerb() This gets the verb that describes this operation.
void	setConferenceName(java.lang.String conferenceName) Sets the name we want to call the Conference
void	setConferenceProperty(java.lang.String noun, 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) Set the States to apply to the Conference.
void	setEndPointList(EndPoint[] endPoints) Adds an array of EndPoint instances into the list of those to be prepopulated into the Conference.
void	setEndPointlist(java.util.List<EndPoint> endPoints) Adds a List of EndPoint instances into the existing list of those to be prepopulated into the Conference.
void	setNumbersToDial(java.util.List<java.lang.String> numbersToDial) Adds a List of numbers into the list of those to be dialed into the Conference.
void	setNumbersToDial(java.lang.String[] numbersToDial) Adds an array of numbers into the list of those to be dialed into the Conference.

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

getConferenceName

public java.lang.String getConferenceName()

Gets the name that has been requested for the Conference

Returns:

the name the Conference will be called, once created

Since:

5.1.0.0.35

setConferenceName

@Required
public void setConferenceName(java.lang.String conferenceName)

Sets the name we want to call the Conference

Parameters:

conferenceName - The name to call the Conference

Since:

5.1.0.0.35

getEndPointList

public EndPoint[] getEndPointList()

Gets an array of the EndPoint instances that will be pre-populated into the Conference.

Returns:

an array of EndPoint instances that will be pre-populated into the Conference.

Since:

5.1.0.0.35

setEndPointList

public void setEndPointList(EndPoint[] endPoints)

Adds an array of EndPoint instances into the list of those to be prepopulated into the Conference. This method DOES NOT clear down the existing list first, merely adds the EndPoint instances.

Parameters:

endPoints - The array of additional EndPoint instances to be prepopulated into the Conference

Since:

5.1.0.0.35

setEndPointlist

public void setEndPointlist(java.util.List<EndPoint> endPoints)

Adds a List of EndPoint instances into the existing list of those to be prepopulated into the Conference. This method DOES NOT clear down the existing list first, merely adds the EndPoint instances.

Parameters:

endPoints - The List of additional EndPoint instances to be prepopulated into the Conference

Since:

5.1.0.0.35

addToEndPointList

public void addToEndPointList(EndPoint endPoint)

Adds an EndPoint to the list that will be pre-populated into the Conference

Parameters:

endPoint - the EndPoint to add to the list

Since:

5.1.0.0.35

getNumbersToDial

public java.lang.String[] getNumbersToDial()

Gets an array (of Strings) of numbers to dial into the Conference.

Returns:

an array (of Strings) of numbers to dial into the Conference.

Since:

5.1.0.0.35

setNumbersToDial

public void setNumbersToDial(java.lang.String[] numbersToDial)

Adds an array of numbers into the list of those to be dialed into the Conference. This method DOES NOT clear down the existing list first, merely adds the numbers.

Parameters:

numbersToDial - The array of additional numbers to dial into the Conference

Since:

5.1.0.0.35

setNumbersToDial

public void setNumbersToDial(java.util.List<java.lang.String> numbersToDial)

Adds a List of numbers into the list of those to be dialed into the Conference. This method DOES NOT clear down the existing list first, merely adds the numbers.

Parameters:

numbersToDial - The List of additional numbers to dial into the Conference

Since:

5.1.0.0.35

addNumberToDial

public void addNumberToDial(java.lang.String numberToDial)

Adds a number to the List of numbers to be dialed into the Conference

Parameters:

numberToDial - The number to add to the list

Since:

5.1.0.0.35

getConferenceProperties

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

Specified by:

getConferenceProperties in interface ConferenceProducingOperation<Create>

Returns:

the conferenceProperties (type Map) of this Dialout object.

Since:

5.1.0.0.34

setConferenceProperty

public void setConferenceProperty(java.lang.String noun,
                                  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.

Specified by:

setConferenceProperty in interface ConferenceProducingOperation<Create>

Parameters:

noun - The name of the property.

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

Since:

5.1.0.0.34

getConferenceStates

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

Gets the States to apply to the Conference.

Specified by:

getConferenceStates in interface ConferenceProducingOperation<Create>

Returns:

the States to apply to the Conference.

Since:

5.1.0.0.34

setConferenceStates

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

Set the States to apply to the Conference.

Specified by:

setConferenceStates in interface ConferenceProducingOperation<Create>

Parameters:

states - the States to apply to the Conference.

Since:

5.1.0.0.34

getImpact

public Operation.Impact getImpact()

Returns the impact of the operation.

Specified by:

getImpact in interface Operation<Conference,Create>

Returns:

the impact.

Since:

5.1.0.0.34

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<Conference,Create>

Returns:

the verb that describes the operation.

Since:

5.1.0.0.34