org.apache.continuum.taskqueue
Interface OverallBuildQueue

All Known Implementing Classes:

DefaultOverallBuildQueue

public interface OverallBuildQueue

Author:

Maria Odea Ching

Method Summary

void	addToBuildQueue(BuildProjectTask buildTask) Add the build task to the build queue.
void	addToBuildQueue(List<BuildProjectTask> buildTasks) Add the build tasks to the build queue.
void	addToCheckoutQueue(CheckOutTask checkoutTask) Add checkout task to checkout queue.
void	addToCheckoutQueue(List<CheckOutTask> checkoutTasks) Add checkout tasks to checkout queue.
void	cancelBuildTask(int projectId) Cancel the build task of the corresponding project.
void	cancelCheckoutTask(int projectId) Cancel checkout of project.
boolean	cancelCurrentBuild() Cancel the current build.
boolean	cancelCurrentCheckout() Cancel current checkout.
org.codehaus.plexus.taskqueue.TaskQueue	getBuildQueue() Returns the build queue.
org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor	getBuildTaskQueueExecutor() Returns the build task queue executor used.
org.codehaus.plexus.taskqueue.TaskQueue	getCheckoutQueue() Returns the checkout queue.
org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor	getCheckoutTaskQueueExecutor() Returns the checkout task queue executor used.
int	getId() Returns the id of the "overall" build queue
String	getName() Returns the name of the "overall" build queue
List<BuildProjectTask>	getProjectsInBuildQueue() Returns the build tasks in the build queue.
List<CheckOutTask>	getProjectsInCheckoutQueue() Get all checkout tasks in checkout queue.
boolean	isInBuildQueue(int projectId) Checks if the specified project is in the build queue.
boolean	isInBuildQueue(int projectId, int buildDefinitionId) Checks if the specified project with the specified build definition is in the build queue.
boolean	isInCheckoutQueue(int projectId) Check if the project is in the checkout queue.
boolean	removeProjectFromBuildQueue(int projectId) Remove the specified project from the build queue.
boolean	removeProjectFromBuildQueue(int projectId, int buildDefinitionId, int trigger, String projectName, int projectGroupId) Remove the project matching the specified id, name, build definition and trigger from the build queue.
boolean	removeProjectFromCheckoutQueue(int projectId) Remove project from checkout queue.
boolean	removeProjectsFromBuildQueue(int[] projectIds) Remove the specified projects from the build queue.
void	removeProjectsFromBuildQueueWithHashCodes(int[] hashCodes) Remove the projects matching the specified hashcodes from the build queue.
boolean	removeProjectsFromCheckoutQueue(int[] projectId) Remove the specified projects in the checkout queue.
void	removeTasksFromCheckoutQueueWithHashCodes(int[] hashCodes)
void	setId(int id)
void	setName(String name)

Method Detail

getId

int getId()

Returns the id of the "overall" build queue

Returns:

setId

void setId(int id)

getName

String getName()

Returns the name of the "overall" build queue

Returns:

setName

void setName(String name)

getCheckoutQueue

org.codehaus.plexus.taskqueue.TaskQueue getCheckoutQueue()

Returns the checkout queue.

Returns:

addToCheckoutQueue

void addToCheckoutQueue(CheckOutTask checkoutTask)
                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Add checkout task to checkout queue.

Parameters:

checkoutTask -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

addToCheckoutQueue

void addToCheckoutQueue(List<CheckOutTask> checkoutTasks)
                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Add checkout tasks to checkout queue.

Parameters:

checkoutTasks -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getProjectsInCheckoutQueue

List<CheckOutTask> getProjectsInCheckoutQueue()
                                              throws org.codehaus.plexus.taskqueue.TaskQueueException

Get all checkout tasks in checkout queue.

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInCheckoutQueue

boolean isInCheckoutQueue(int projectId)
                          throws org.codehaus.plexus.taskqueue.TaskQueueException

Check if the project is in the checkout queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

cancelCheckoutTask

void cancelCheckoutTask(int projectId)
                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Cancel checkout of project.

Parameters:

projectId -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException

cancelCurrentCheckout

boolean cancelCurrentCheckout()

Cancel current checkout.

Returns:

TODO

removeProjectFromCheckoutQueue

boolean removeProjectFromCheckoutQueue(int projectId)
                                       throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove project from checkout queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectsFromCheckoutQueue

boolean removeProjectsFromCheckoutQueue(int[] projectId)
                                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the specified projects in the checkout queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeTasksFromCheckoutQueueWithHashCodes

void removeTasksFromCheckoutQueueWithHashCodes(int[] hashCodes)
                                               throws org.codehaus.plexus.taskqueue.TaskQueueException

Parameters:

hashCodes -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getBuildQueue

org.codehaus.plexus.taskqueue.TaskQueue getBuildQueue()

Returns the build queue.

Returns:

addToBuildQueue

void addToBuildQueue(BuildProjectTask buildTask)
                     throws org.codehaus.plexus.taskqueue.TaskQueueException

Add the build task to the build queue.

Parameters:

buildTask -

Throws:

Exception

org.codehaus.plexus.taskqueue.TaskQueueException

addToBuildQueue

void addToBuildQueue(List<BuildProjectTask> buildTasks)
                     throws org.codehaus.plexus.taskqueue.TaskQueueException

Add the build tasks to the build queue.

Parameters:

buildTasks -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getProjectsInBuildQueue

List<BuildProjectTask> getProjectsInBuildQueue()
                                               throws org.codehaus.plexus.taskqueue.TaskQueueException

Returns the build tasks in the build queue.

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInBuildQueue

boolean isInBuildQueue(int projectId)
                       throws org.codehaus.plexus.taskqueue.TaskQueueException

Checks if the specified project is in the build queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInBuildQueue

boolean isInBuildQueue(int projectId,
                       int buildDefinitionId)
                       throws org.codehaus.plexus.taskqueue.TaskQueueException

Checks if the specified project with the specified build definition is in the build queue.

Parameters:

projectId -

buildDefinitionId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

cancelBuildTask

void cancelBuildTask(int projectId)

Cancel the build task of the corresponding project.

Parameters:

projectId -

cancelCurrentBuild

boolean cancelCurrentBuild()

Cancel the current build.

Returns:

removeProjectFromBuildQueue

boolean removeProjectFromBuildQueue(int projectId,
                                    int buildDefinitionId,
                                    int trigger,
                                    String projectName,
                                    int projectGroupId)
                                    throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the project matching the specified id, name, build definition and trigger from the build queue.

Parameters:

projectId -

buildDefinitionId -

trigger -

projectName -

projectGroupId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectFromBuildQueue

boolean removeProjectFromBuildQueue(int projectId)
                                    throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the specified project from the build queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectsFromBuildQueue

boolean removeProjectsFromBuildQueue(int[] projectIds)
                                     throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the specified projects from the build queue.

Parameters:

projectIds -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectsFromBuildQueueWithHashCodes

void removeProjectsFromBuildQueueWithHashCodes(int[] hashCodes)
                                               throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the projects matching the specified hashcodes from the build queue.

Parameters:

hashCodes -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getBuildTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getBuildTaskQueueExecutor()

Returns the build task queue executor used.

Returns:

getCheckoutTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getCheckoutTaskQueueExecutor()

Returns the checkout task queue executor used.

Returns: