com.avaya.conferencing.api.acp.control
Interface ConferencingObject<T extends ConferencingObject<T>>

Type Parameters:

T - Implementing classes use this type parameter to provide type safety for references. An example is the Conference interface public interface Conference extends ConferencingObject<Conference> which enables conference.getId() to return a Reference<Conference> and not a Reference<ConferencingObject>.

All Known Subinterfaces:

ConferenceContainer<IMPL_CLASS>, ConferencingObjectContainer<T>, ConferencingObjectQueue<Q,E>, EndPointContainer<IMPL_CLASS>

All Known Implementing Classes:

AbstractConferencingObject, CallFlowMappingRule, Conference, ConferenceQueue, Connection, EndPoint, EndPointQueue, MediaSource, Message, Operator, ParticipantCodeGroup, RecordPlaybackServer

public interface ConferencingObject<T extends ConferencingObject<T>>

ConferencingObject are read-only JavaBeans which support Operations. For each of the properties returned by getProperties(), there will be a public accessor following the getXXX or isXXX rule used for JavaBeans. The getPropertyValue() method can be used for dynamic querying without using the reflection APIs.

API Implementataion Notes

Implementations of this API should not directly implement this interface, but should instead extend one of the abstract classes:

• AbstractConferencingObject
• Conference
• ConferenceQueue
• Connection
• EndPoint
• EndPointQueue

Since:

5.1.0.0.29

Field Summary

static java.lang.String

STATE The property name for getState().

Method Summary

void	addAvailableVerbsChangeListener(AvailableVerbsChangeListener listener) Registers a AvailableVerbsChangeListener against this ConferencingObject instance.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against all properties of this ConferencingObject instance.
void	addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against specific properties of this ConferencingObject instance.
void	addStateChangeListener(State state, StateChangeListener listener) Registers a StateChangeListener against specific states of this ConferencingObject instance.
<OP extends Operation<RESULT,OP>,RESULT> OP	execute(OP operation) Executes the operation using the connection's authentication.
<OP extends Operation<RESULT,OP>,RESULT> OP	executeAs(CPAuthentication authentication, OP operation) Executes the operation using the supplied authentication.
java.util.Set<Verb>	getAllVerbs() Returns all possible verbs that the connection's authentication could be allowed to execute against this ConferencingObject instance.
java.util.Set<Verb>	getAllVerbsAs(java.lang.Class<? extends CPAuthentication> clazz) Returns all possible verbs that the specified type of authentication could be allowed to execute against this ConferencingObject instance.
java.util.Set<Verb>	getAllVerbsAs(CPAuthentication authentication) Returns all possible verbs that the specified authentication could be allowed to execute against this ConferencingObject instance.
Connection	getConnection() Returns the connection that this ConferencingObject relates to.
Reference<T>	getId() Get the unique reference for this ConferencingObject.
java.util.Set<java.lang.String>	getProperties() Returns the properties of this ConferencingObject instance.
java.util.Set<java.lang.String>	getProperties(PropertyType type) Returns the properties of this ConferencingObject instance.
java.lang.Class	getPropertyClass(java.lang.String property) Returns a specific property class.
java.util.Map<java.lang.String,java.lang.Class>	getPropertyClasses() Returns all the property classes of this object.
PropertyType	getPropertyType(java.lang.String property) Returns a specific property class.
java.lang.Object	getPropertyValue(java.lang.String property) Returns a specific property value.
java.util.Map<java.lang.String,java.lang.Object>	getPropertyValues() Returns all the property values of this object.
java.util.Set<State>	getState() Gets the state of this ConferencingObject.
java.util.Set<Verb>	getVerbs() Returns the verbs that the connection's authentication is allowed to execute against this ConferencingObject instance.
java.util.Set<Verb>	getVerbsAs(CPAuthentication authentication) Returns the verbs that the specified authentication is allowed to execute against this ConferencingObject instance.
void	removeAvailableVerbsChangeListener(AvailableVerbsChangeListener listener) Unregisters a AvailableVerbsChangeListener previously registered against this ConferencingObject instance.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against all properties of this ConferencingObject instance.
void	removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against a specific property of this ConferencingObject instance.
void	removeStateChangeListener(State state, StateChangeListener listener) Unregisters a StateChangeListener previously registered against a specific state of this ConferencingObject instance.

Field Detail

STATE

static final java.lang.String STATE

The property name for getState().

Since:

5.1.0.0.29

Method Detail

addAvailableVerbsChangeListener

void addAvailableVerbsChangeListener(AvailableVerbsChangeListener listener)

Registers a AvailableVerbsChangeListener against this ConferencingObject instance.

Parameters:

listener - The AvailableVerbsChangeListener

Since:

5.1.0.0.29

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Registers a PropertyChangeListener against all properties of this ConferencingObject instance.

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

addPropertyChangeListener

void addPropertyChangeListener(java.lang.String property,
                               java.beans.PropertyChangeListener listener)

Registers a PropertyChangeListener against specific properties of this ConferencingObject instance.

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

addStateChangeListener

void addStateChangeListener(State state,
                            StateChangeListener listener)

Registers a StateChangeListener against specific states of this ConferencingObject instance. If you need to listen for multiple states changing consider adding a PropertyChangeListener for the STATE property.

Parameters:

state - The state to listen for changes on.

listener - The StateChangeListener.

Since:

5.1.0.0.29

execute

<OP extends Operation<RESULT,OP>,RESULT> OP execute(OP operation)

Executes the operation using the connection's authentication.

Parameters:

operation - The operation to execute.

Returns:

The operation that was submitted to allow for easier method chaining.

Throws:

InsufficientPermissionsException - Registers if the connection's authentication does not have permission to execute this operation against this instance.

InvalidOperationException - Registers if this ConferencingObject instance does not support the operation.

Since:

5.1.0.0.29

executeAs

<OP extends Operation<RESULT,OP>,RESULT> OP executeAs(CPAuthentication authentication,
                                                      OP operation)

Executes the operation using the supplied authentication.

Parameters:

authentication - The authentication to execute the operation as.

operation - The operation to execute.

Returns:

The operation that was submitted to allow for easier method chaining.

Throws:

InsufficientPermissionsException - If the identity's authentication does not have permission to execute this operation against this instance.

InvalidOperationException - If this ConferencingObject instance does not support the operation.

Since:

5.1.0.0.29

getAllVerbs

java.util.Set<Verb> getAllVerbs()

Returns all possible verbs that the connection's authentication could be allowed to execute against this ConferencingObject instance. The return value of this function will be constant for the life of the ConferencingObject instance.

Returns:

All verbs that could be executed using the connection's authentication.

Since:

5.1.0.0.29

getAllVerbsAs

java.util.Set<Verb> getAllVerbsAs(CPAuthentication authentication)

Returns all possible verbs that the specified authentication could be allowed to execute against this ConferencingObject instance. The return value of this function will be constant for the life of the ConferencingObject instance.

Parameters:

authentication - The specified authentication.

Returns:

All verbs that could be executed using the identity's authentication.

Since:

5.1.0.0.29

getAllVerbsAs

java.util.Set<Verb> getAllVerbsAs(java.lang.Class<? extends CPAuthentication> clazz)

Returns all possible verbs that the specified type of authentication could be allowed to execute against this ConferencingObject instance. The return value of this function will be constant for the life of the ConferencingObject instance.

Parameters:

clazz - The specified type of authentication.

Returns:

All verbs that could be executed using the identity's authentication.

Since:

5.1.0.0.42

getConnection

Connection getConnection()

Returns the connection that this ConferencingObject relates to.

Returns:

The underlying connection for this ConferencingObject.

Since:

5.1.0.0.29

getId

Reference<T> getId()

Get the unique reference for this ConferencingObject. References are tied to their underlying connections.

Returns:

The reference for this ConferencingObject.

Since:

5.1.0.0.29

getProperties

java.util.Set<java.lang.String> getProperties()

Returns the properties of this ConferencingObject instance.

Returns:

The properties of this ConferencingObject.

Since:

5.1.0.0.29

getProperties

java.util.Set<java.lang.String> getProperties(PropertyType type)

Returns the properties of this ConferencingObject instance.

Parameters:

type - The type of properties to return.

Returns:

The properties of this ConferencingObject.

Since:

5.1.0.0.29

getPropertyClass

java.lang.Class getPropertyClass(java.lang.String property)

Returns a specific property class.

Parameters:

property - The property.

Returns:

The property class. Usually one of

• Boolean
• Integer
• Long
• String
• Date

Although future versions may return additional types.

Since:

5.1.0.0.29

getPropertyClasses

java.util.Map<java.lang.String,java.lang.Class> getPropertyClasses()

Returns all the property classes of this object.

Returns:

the properties and their classes.

Since:

5.1.0.0.29

getPropertyType

PropertyType getPropertyType(java.lang.String property)

Returns a specific property class.

Parameters:

property - The property.

Returns:

The property type.

Since:

5.1.0.0.29

getPropertyValue

java.lang.Object getPropertyValue(java.lang.String property)

Returns a specific property value.

Parameters:

property - The property.

Returns:

The property value.

Since:

5.1.0.0.29

getPropertyValues

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

Returns all the property values of this object.

Returns:

The properties and their values.

Since:

5.1.0.0.29

getState

java.util.Set<State> getState()

Gets the state of this ConferencingObject. The state is represented as set of State instances.

Returns:

the state of this ConferencingObject.

Since:

5.1.0.0.29

getVerbs

java.util.Set<Verb> getVerbs()

Returns the verbs that the connection's authentication is allowed to execute against this ConferencingObject instance. The return value of this function can change as the instance's state changes. Use addAvailableVerbsChangeListener(com.avaya.conferencing.api.acp.control.events.AvailableVerbsChangeListener) to be notified of changes to this list.

Returns:

The verbs that can be executed using the connection's authentication.

Since:

5.1.0.0.29

See Also:

addAvailableVerbsChangeListener(com.avaya.conferencing.api.acp.control.events.AvailableVerbsChangeListener), removeAvailableVerbsChangeListener(com.avaya.conferencing.api.acp.control.events.AvailableVerbsChangeListener), AvailableVerbsChangeListener, AvailableVerbsChangeEvent

getVerbsAs

java.util.Set<Verb> getVerbsAs(CPAuthentication authentication)

Returns the verbs that the specified authentication is allowed to execute against this ConferencingObject instance. The return value of this function can change as the instance's state changes. Use addAvailableVerbsChangeListener(com.avaya.conferencing.api.acp.control.events.AvailableVerbsChangeListener) to be notified of changes to this list.

Parameters:

authentication - The specified authentication.

Returns:

The verbs that can be executed using the identity's authentication.

Since:

5.1.0.0.29

See Also:

addAvailableVerbsChangeListener(com.avaya.conferencing.api.acp.control.events.AvailableVerbsChangeListener), removeAvailableVerbsChangeListener(com.avaya.conferencing.api.acp.control.events.AvailableVerbsChangeListener), AvailableVerbsChangeListener, AvailableVerbsChangeEvent

removeAvailableVerbsChangeListener

void removeAvailableVerbsChangeListener(AvailableVerbsChangeListener listener)

Unregisters a AvailableVerbsChangeListener previously registered against this ConferencingObject instance.

Parameters:

listener - The AvailableVerbsChangeListener

Since:

5.1.0.0.29

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Unregisters a PropertyChangeListener previously registered against all properties of this ConferencingObject instance.

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

removePropertyChangeListener

void removePropertyChangeListener(java.lang.String property,
                                  java.beans.PropertyChangeListener listener)

Unregisters a PropertyChangeListener previously registered against a specific property of this ConferencingObject instance.

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

removeStateChangeListener

void removeStateChangeListener(State state,
                               StateChangeListener listener)

Unregisters a StateChangeListener previously registered against a specific state of this ConferencingObject instance.

Parameters:

state - The state to listen for changes on.

listener - The StateChangeListener.

Since:

5.1.0.0.29