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

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

All Implemented Interfaces:

Operation<java.util.Set<java.lang.String>,ModifyDetails>, java.lang.Cloneable

public class ModifyDetails
extends AbstractOperationImpl<java.util.Set<java.lang.String>,ModifyDetails>

Modifies the properties of a ConferencingObject.

The operation will return a set of the names of those properties that were successfully modified.

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

void	addPropertyValue(java.lang.String name, java.lang.Object value) Adds a property to be modified.
void	clearProperties() Removes all the property changes from this Operation.
Operation.Impact	getImpact() Returns the impact of the operation.
boolean	getPriority()
java.util.Map<java.lang.String,java.lang.Object>	getPropertyValues() Returns the (unmodifiable) map of properties to modify and their associated new values.
Verb	getVerb() This gets the verb that describes this operation.
boolean	isValidating() Returns true if this operation will validate all property values before attempting to modify them.
void	setPriority(boolean priority) Sets priority of operation.
void	setPropertyValues(java.util.Map<java.lang.String,java.lang.Object> properties) Sets the properties to modify and their associated new values.
void	setValidating(boolean validating) When true the properties will only be modified if all the properties are valid.

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

isValidating

public boolean isValidating()

Returns true if this operation will validate all property values before attempting to modify them.

Returns:

true if this operation will validate all property values before attempting to modify them.

Since:

5.1.0.0.29

setValidating

public void setValidating(boolean validating)

When true the properties will only be modified if all the properties are valid.

Parameters:

validating - true to ensure that properties will only be modified if all the properties are valid.

Since:

5.1.0.0.29

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

addPropertyValue

public void addPropertyValue(java.lang.String name,
                             java.lang.Object value)

Adds a property to be modified.

Parameters:

name - The property name to modify.

value - The new value for the property.

Since:

5.1.0.0.29

clearProperties

public void clearProperties()

Removes all the property changes from this Operation.

Since:

5.1.0.0.29

getPropertyValues

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

Returns the (unmodifiable) map of properties to modify and their associated new values.

Returns:

The (unmodifiable) map of properties to modify and their associated new values.

Since:

5.1.0.0.29

setPropertyValues

@Required
public void setPropertyValues(java.util.Map<java.lang.String,java.lang.Object> properties)

Sets the properties to modify and their associated new values.

Parameters:

properties - The properties to modify and their associated new values.

Since:

5.1.0.0.29

setPriority

public void setPriority(boolean priority)

Sets priority of operation. Do not call this method outside the library.

getPriority

public boolean getPriority()