com.xebialabs.deployit.engine.api
Interface ControlService

public interface ControlService

Provides access to control methods defined on CIs.

Method Summary

java.lang.String	createTask(Control control) Creates the control task.
Control	prepare(java.lang.String controlName, java.lang.String id) Returns a parameter object for the task that will execute the control task method.

Method Detail

prepare

Control prepare(java.lang.String controlName,
                java.lang.String id)

Returns a parameter object for the task that will execute the control task method. The returned object can be used in the call to /control.

Parameters:

controlName - The name of the control method to execute.

id - the CI to execute the control method on

Returns:

a Control parameter object.

createTask

java.lang.String createTask(Control control)

Creates the control task.

Parameters:

control - the Control parameter object, created by invoking /control/prepare.

Returns:

a reference to a Task ID that can be executed by the TaskService.