com.xebialabs.deployit.task
Interface TaskArchive

All Known Implementing Classes:

JcrTaskArchive

public interface TaskArchive

Method Summary

void	archiveTask(DeploymentTask task) Archives a deployment task to the task archive persistent store.
java.util.List<java.lang.String>	getAllTaskIds() Searches the persistent store for archived tasks Id's.
DeploymentTaskInfo	getTask(java.lang.String taskId) Retrieve a from the persistent store, using the taskId
java.util.Collection<DeploymentTaskInfo>	searchTasks(ArchivedTaskSearchParameters archivedTaskSearchParameters) Searches the persistent store for archived tasks.
void	searchTasks(ArchivedTaskSearchParameters archivedTaskSearchParameters, JcrTaskArchive.TaskCallback callback) Searches the persistent store for archived tasks and executes the callback method on the result.
java.util.Collection<DeploymentTaskInfo>	searchTasksWithoutLoadingSteps(ArchivedTaskSearchParameters archivedTaskSearchParameters) Searches the persistent store for archived tasks.It doesn't load steps of tasks.
java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>>	searchTasksWithoutLoadingSteps(ArchivedTaskSearchParameters sp, GroupBy groupBy) Searches the persistent store for archived tasks and groups by given parameters.
void	searchTasksWithoutLoadingSteps(ArchivedTaskSearchParameters archivedTaskSearchParameters, JcrTaskArchive.TaskCallback callback) Searches the persistent store for archived tasks and executes the callback method on the result.

Method Detail

archiveTask

void archiveTask(DeploymentTask task)

Archives a deployment task to the task archive persistent store.

Parameters:

task - is the deployment task to archive.

getTask

DeploymentTaskInfo getTask(java.lang.String taskId)

Retrieve a from the persistent store, using the taskId

Parameters:

taskId - can be a fully qualified path to the task, or the tasks uuid.

Returns:

DeploymentTaskInfo which is never null

Throws:

NotFoundException - when task is not found.

searchTasks

java.util.Collection<DeploymentTaskInfo> searchTasks(ArchivedTaskSearchParameters archivedTaskSearchParameters)

Searches the persistent store for archived tasks.

Parameters:

archivedTaskSearchParameters - to use to build the search query.

Returns:

results of search. Never null.

searchTasksWithoutLoadingSteps

java.util.Collection<DeploymentTaskInfo> searchTasksWithoutLoadingSteps(ArchivedTaskSearchParameters archivedTaskSearchParameters)

Searches the persistent store for archived tasks.It doesn't load steps of tasks.

Parameters:

archivedTaskSearchParameters - to use to build the search query.

Returns:

results of search. Never null.

searchTasks

void searchTasks(ArchivedTaskSearchParameters archivedTaskSearchParameters,
                 JcrTaskArchive.TaskCallback callback)

Searches the persistent store for archived tasks and executes the callback method on the result.

Parameters:

archivedTaskSearchParameters - to use to build the search query.

callback - Callback method.

searchTasksWithoutLoadingSteps

void searchTasksWithoutLoadingSteps(ArchivedTaskSearchParameters archivedTaskSearchParameters,
                                    JcrTaskArchive.TaskCallback callback)

Searches the persistent store for archived tasks and executes the callback method on the result. It doesn't load steps of tasks.

Parameters:

archivedTaskSearchParameters - to use to build the search query.

callback - Callback method.

searchTasksWithoutLoadingSteps

java.util.Collection<java.util.Map<java.lang.String,java.lang.Object>> searchTasksWithoutLoadingSteps(ArchivedTaskSearchParameters sp,
                                                                                                      GroupBy groupBy)

Searches the persistent store for archived tasks and groups by given parameters. It doesn't load steps of tasks.

Parameters:

sp -

groupBy -

Returns:

getAllTaskIds

java.util.List<java.lang.String> getAllTaskIds()

Searches the persistent store for archived tasks Id's.

Returns:

results list of all task Id's. List might be empty.