Package com._1c.g5.v8.dt.team

Interface IDevelopmentProcessManager

public interface IDevelopmentProcessManager

Development process manager allows clients to start development process or get existing development processes.

Example of usage:

 // 1. get project somehow to create development process for
 IProject project = getProject();

 // 2. configure issue type and deployment type
 IIssueType issueType = issueTypeRepository.getDefault();
 IDeploymentType deploymentType = deploymentTypeProvider.getAll().iterator().next();

 // 3. configure development options
 DevelopmentOptions options = new DevelopmentOptions(deploymentType);

 // 4. create development process
 developmentProcessManager.create("my-feature", project, issueType, options, monitor);
 

Restriction:

This interface is not intended to be extended by clients.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

Modifier and Type	Method	Description
void	addListener(IDevelopmentProcessManagerListener listener)	Adds development process manager listener.
IIssueDescriptor	create(String name, org.eclipse.core.resources.IProject project, IIssueType issueType, IDeploymentType deploymentType, DevelopmentOptions options, org.eclipse.core.runtime.IProgressMonitor monitor)	Creates the new development process with the provided name and options.
void	delete(IIssueDescriptor issue, org.eclipse.core.resources.IProject project, DevelopmentOptions options, org.eclipse.core.runtime.IProgressMonitor monitor)	Deletes the development environment for the provided issue descriptor.
Optional<IIssueDescriptor>	get(String id, org.eclipse.core.resources.IProject project)	Returns the development issue descriptor with the provided identifier.
Collection<IIssueDescriptor>	getAll(org.eclipse.core.resources.IProject project)	Returns a collection of all current development issue descriptors.
void	removeListener(IDevelopmentProcessManagerListener listener)	Removes development process manager listener.

Method Detail

get

Optional<IIssueDescriptor> get(String id,
                               org.eclipse.core.resources.IProject project)
                        throws DevelopmentProcessException

Returns the development issue descriptor with the provided identifier.

Parameters:

id - the identifier of the development issue, cannot be null

project - the workspace project, cannot be null

Returns:

the development issue descriptor with the provided identifier

Throws:

DevelopmentProcessException - if development issue get failed

getAll

Collection<IIssueDescriptor> getAll(org.eclipse.core.resources.IProject project)
                             throws DevelopmentProcessException

Returns a collection of all current development issue descriptors.

Parameters:

project - the workspace project, cannot be null

Returns:

a collection of all current development issue descriptors, never null

Throws:

DevelopmentProcessException - if development issue get failed

create

IIssueDescriptor create(String name,
                        org.eclipse.core.resources.IProject project,
                        IIssueType issueType,
                        IDeploymentType deploymentType,
                        DevelopmentOptions options,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws DevelopmentProcessException

Creates the new development process with the provided name and options. Development VCS branch and development environment may be created and configured during process creation based on the provided development options.

This method is long-running, progress and cancellation are provided by the progress monitor.

Parameters:

name - the name of the issue to create, cannot be null

project - the project to create issure for, cannot be null

issueType - the issue type to create, cannot be null

deploymentType - the development deployment type, never null

options - the development options to create development process with, cannot be null

monitor - the progress monitor to report progress to or null if not needed

Returns:

a description of the created development issue, never null

Throws:

DevelopmentProcessException - if development process creation failed

See Also:

DevelopmentOptions

delete

void delete(IIssueDescriptor issue,
            org.eclipse.core.resources.IProject project,
            DevelopmentOptions options,
            org.eclipse.core.runtime.IProgressMonitor monitor)
     throws DevelopmentProcessException

Deletes the development environment for the provided issue descriptor.

Parameters:

issue - the issue to delete development environment for, cannot be null

project - the workspace project, cannot be null

options - the development options to delete development process with, cannot be null

monitor - the progress monitor to report progress to or null if not needed

Throws:

DevelopmentProcessException - if development process delete failed

addListener

void addListener(IDevelopmentProcessManagerListener listener)

Adds development process manager listener. Listener will receive issue descriptors changed events.

Parameters:

listener - - listener to add, cannot be null

removeListener

void removeListener(IDevelopmentProcessManagerListener listener)

Removes development process manager listener. Listener will not receive issue descriptors changed events anymore.

Parameters:

listener - - listener to remove, cannot be null