com.avaya.conferencing.api.acp.control.operations
Interface BulkOperation<RESULT>

public interface BulkOperation<RESULT>

Performs an operation against a collection of conferencing objects.

Since:

5.1.0.0.46

Method Summary

void	await() Blocks until all of the operations are completed.
boolean	await(long timeout, java.util.concurrent.TimeUnit unit) Causes the current thread to wait until all of the operations are completed, unless the thread is interrupted, or the specified waiting time elapses.
java.util.Map<ConferencingObject<? extends ConferencingObject<?>>,RESULT>	getCompleted() Returns a map keyed on the conferencing object with the values being the results of all the completed operations.
java.util.Map<ConferencingObject<? extends ConferencingObject<?>>,java.lang.Throwable>	getFailed() Returns a map keyed on the conferencing object with the values being the exceptions thrown by all the completed failed operations.
boolean	isDone() Returns true if all operations have completed.
boolean	isSubmitted() Returns true if the operations have been submitted.
BulkOperation<RESULT>	perform() Submits the operation against all the target objects.
BulkOperation<RESULT>	performAs(CPAuthentication authentication) Submits the operation against all the targets using a specific authentication.

Method Detail

isSubmitted

boolean isSubmitted()

Returns true if the operations have been submitted.

Returns:

true if the operations have been submitted.

Since:

5.1.0.0.46

perform

BulkOperation<RESULT> perform()

Submits the operation against all the target objects.

Returns:

this to support method chaining.

Since:

5.1.0.0.46

performAs

BulkOperation<RESULT> performAs(CPAuthentication authentication)

Submits the operation against all the targets using a specific authentication.

Parameters:

authentication - The authentication.

Returns:

this to support method chaining.

Since:

5.1.0.0.46

isDone

boolean isDone()

Returns true if all operations have completed.

Returns:

true if all operations have completed.

Since:

5.1.0.0.46

getCompleted

java.util.Map<ConferencingObject<? extends ConferencingObject<?>>,RESULT> getCompleted()

Returns a map keyed on the conferencing object with the values being the results of all the completed operations.

Returns:

a map keyed on the conferencing object with the values being the results of all the completed operations.

Since:

5.1.0.0.46

getFailed

java.util.Map<ConferencingObject<? extends ConferencingObject<?>>,java.lang.Throwable> getFailed()

Returns a map keyed on the conferencing object with the values being the exceptions thrown by all the completed failed operations.

Returns:

a map keyed on the conferencing object with the values being the exceptions thrown by all the completed failed operations.

Since:

5.1.0.0.46

await

boolean await(long timeout,
              java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Causes the current thread to wait until all of the operations are completed, unless the thread is interrupted, or the specified waiting time elapses.

If all the operation are completed then this method returns immediately.

If any operation has yet to complete then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happen:

• All of the operation complete; or
• Some other thread interrupts the current thread; or
• The specified waiting time elapses.

If all of the operations complete then the method returns with the value true.

If the current thread:

• has its interrupted status set on entry to this method; or
• is interrupted while waiting,

then InterruptedException is thrown and the current thread's interrupted status is cleared.

If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Parameters:

timeout - The maximum time to wait.

unit - The time unit of the timeout argument.

Returns:

true If all of the operations completed and false if the waiting time elapsed before the operation completed.

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting.

Since:

5.1.0.0.46

await

void await()
           throws java.lang.InterruptedException

Blocks until all of the operations are completed. Completion of the operations may be due to normal termination or an exception.

If all of the operation are completed then this method returns immediately.

If any operation has yet to complete then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happen:

• All of the operation are complete; or
• some other thread interrupts the current thread.

If the current thread:

• has its interrupted status set on entry to this method; or
• is interrupted while waiting,

then InterruptedException is thrown and the current thread's interrupted status is cleared.

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting.

Since:

5.1.0.0.46