org.figure8.join.businessfacades.commons
Interface IntegrationProcessManager

All Known Implementing Classes:

DefaultIntegrationProcessManager

public interface IntegrationProcessManager

This is a service interface providing methods for managing the process lifecycle supported by the Join instance running the software project integration.
Implementation of this methods should define how process steps, roadmap releases, deployment targets and so on are created, updated and retrieved.

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Method Summary

Release	getRelease(java.lang.String name) Retrieve a Release of software project using its name
java.util.List	getReleases() Retrieve the available releases of software project managed by Join.
java.util.List	getStatus() Retrieve the available status defining the integration process.
Status	getStatus(long id) Retrieve a Status of integration process using its datastore id
Status	getStatus(java.lang.String key) Retrieve a Status of integration process using its key
java.util.List	getStatusForType(java.lang.String type) Retrieve the available status for the specified integration process
Step	getStep(long id) Retrieve a Step of integration process using its datastore id
Step	getStep(java.lang.String label) Retrieve a Step of integration process using its label
java.util.List	getSteps() Retrieve the available steps defining the integration process.
Target	getTarget(java.lang.String name) Retrieve the deployment target having the specified name.
java.util.List	getTargets() Retrieve the deployment targets defining the deployment options for software.
void	saveRelease(Release release) Save a release within datastore.
void	saveStatus(Status status) Save a status within datastore.
void	saveStep(Step step) Save a step within datastore.
void	saveTarget(Target target) Save a deployment target within datastore.

Method Detail

saveStatus

void saveStatus(Status status)
                throws DuplicateEntityException

Save a status within datastore.

Parameters:

status - The status to save (create or update)

Throws:

DuplicateEntityException - if another status with same name already exists

getStatus

java.util.List getStatus()

Retrieve the available status defining the integration process.

Returns:

A List of org.figure8.join.businessobjects.commons.Status

getStatusForType

java.util.List getStatusForType(java.lang.String type)

Retrieve the available status for the specified integration process

Parameters:

type - The type of process to retrieve status for

Returns:

A List of org.figure8.join.businessobjects.commons.Status

getStatus

Status getStatus(long id)

Retrieve a Status of integration process using its datastore id

Parameters:

id - The datastore identifier of step to retrieve

Returns:

The corresponding step of null is no step has this id

getStatus

Status getStatus(java.lang.String key)

Retrieve a Status of integration process using its key

Parameters:

key - The key of status to retrieve

Returns:

The corresponding status or null if no step has this key

saveStep

void saveStep(Step step)

Save a step within datastore.

Parameters:

step - The step to save (create or update)

getSteps

java.util.List getSteps()

Retrieve the available steps defining the integration process.

Returns:

A List of org.figure8.join.businessobjects.commons.Step

getStep

Step getStep(long id)

Retrieve a Step of integration process using its datastore id

Parameters:

id - The datastore identifier of step to retrieve

Returns:

The corresponding step of null is no step has this id

getStep

Step getStep(java.lang.String label)

Retrieve a Step of integration process using its label

Parameters:

label - The label of step to retrieve

Returns:

The corresponding step or null if no step has this label

saveTarget

void saveTarget(Target target)
                throws DuplicateEntityException

Save a deployment target within datastore.

Parameters:

target - The target to save (create or update)

Throws:

DuplicateEntityException - if another target with same name already exists

getTargets

java.util.List getTargets()

Retrieve the deployment targets defining the deployment options for software.

Returns:

A List of org.figure8.join.businessobjects.commons.Target

getTarget

Target getTarget(java.lang.String name)

Retrieve the deployment target having the specified name.

Parameters:

name - The name of the deployment target to retrieve

Returns:

The corresponding target or null is no target has this name

saveRelease

void saveRelease(Release release)
                 throws DuplicateEntityException

Save a release within datastore. The major and minor numbers pair should be unique otherwise a DuplicateEntityException is thrown by persistence layer.

Parameters:

release - The release to save (create or update)

Throws:

DuplicateEntityException - if another release with same major and minor already exists

getReleases

java.util.List getReleases()

Retrieve the available releases of software project managed by Join.

Returns:

A List of org.figure8.join.businessobjects.commons.Release

getRelease

Release getRelease(java.lang.String name)

Retrieve a Release of software project using its name

Parameters:

name - The name of release to retrieve

Returns:

The corresponding release or null if no release has this name