oracle.wsc.feature.webrtc.template.future

Interface TaskBuilder

public interface TaskBuilder

Builder class used to build Task instances. A task must have at least one Future object associated with it.

Method Summary

Modifier and Type	Method and Description
Task	build() Build the task.
TaskBuilder	onError(WscFuture<?> future) The task is executed only if all of the WscFuture object results in an error.
TaskBuilder	onError(WscFuture<?> future, String name) The task will be executed only if all of the WscFuture object results in an error.
TaskBuilder	onSuccess(WscFuture<?> future) The task is executed if all the WscFuture objects are ready.
TaskBuilder	onSuccess(WscFuture<?> future, String name) The task is executed if all the WscFuture objects are ready.
TaskBuilder	withArg(String name, Object value) Argument map made available for the callback groovy function.

Method Detail

withArg

TaskBuilder withArg(String name,
                    Object value)

Argument map made available for the callback groovy function.

Parameters:

name - name of the argument

value - value of the argument

Returns:

builder

onSuccess

TaskBuilder onSuccess(WscFuture<?> future)

The task is executed if all the WscFuture objects are ready. This method can be invoked multiple times with different future objects.

Parameters:

future - Future object

Returns:

builder

onSuccess

TaskBuilder onSuccess(WscFuture<?> future,
                      String name)

The task is executed if all the WscFuture objects are ready. This method can be invoked multiple times with different future objects. The future object is made available to the callback function with the specified name.

Parameters:

future - Future object

name - name of the argument

Returns:

builder

onError

TaskBuilder onError(WscFuture<?> future)

The task is executed only if all of the WscFuture object results in an error. This method can be invoked multiple times with different future objects. If any one task results in an error, multiple tasks can be created with one onError for each of them.

Parameters:

future - Future object

Returns:

builder

onError

TaskBuilder onError(WscFuture<?> future,
                    String name)

The task will be executed only if all of the WscFuture object results in an error. This method can be invoked multiple times with different future objects. If any one task results in a failure, multiple tasks can be created with one onError for each of them. The future object will be made available to the callback function with the specified name.

Parameters:

future - Future object

name - Name of argument that expose the future.

Returns:

builder

build

Task build()

Build the task. As part of this method call, this TaskImpl is associated with the SIP application session (SAS). On receipt of response for the asynchronous call, the SAS is identified and the tasks associated with the SAS are executed if all the future objects are ready.

Returns:

The task.