net.sourceforge.groboutils.pmti.v1
Interface IProblemManager

All Known Implementing Classes:

ITFReadProblemManager

public interface IProblemManager

The master class (generally a facade) responsible for interfacing the programmer with the Problem Management Tracker, implementing not only the query and change elements, but also enforcing the workflow logic associated with the underlying tracker.

Since:

July 7, 2002

Version:

$Date: 2003/02/10 22:51:54 $

Author:

Matt Albrecht groboclown@users.sourceforge.net

Method Summary

IEditableIssue	createIssue(java.lang.String type) Creates a new issue of the given type.
IEditableIssue	editIssue(IIssue issue) Given the real issue, returns the editable version of the issue.
IIssue	getIssueByID(java.lang.String id) Returns the issue associated with the given unique issue ID.
java.lang.String[]	getIssueIDs() Returns a list of all issue IDs known by the PMT.
java.lang.String[]	getIssueIDsForTemplate(IIssue issue) Returns all issue IDs that match the given 'template'.
IProblemManagerInfo	getProblemManagerInfo() Returns all meta-data for this problem management tracker.

Method Detail

getIssueIDs

public java.lang.String[] getIssueIDs()
                               throws ProblemManagerException

Returns a list of all issue IDs known by the PMT. This may be an extremely expensive operation, depending on the size of the underlying system. This call must never return null. This should never return new issues that have not been comitted yet.

Throws:

ProblemManagerException

getIssueIDsForTemplate

public java.lang.String[] getIssueIDsForTemplate(IIssue issue)
                                          throws ProblemManagerException

Returns all issue IDs that match the given 'template'. A template is an issue where all null values are considered 'wildcards', so that a null state, for instance, would match for any state object. May change the template in the future to a different but similar type to allow for regular-expressions.

Throws:

ProblemManagerException

getIssueByID

public IIssue getIssueByID(java.lang.String id)
                    throws ProblemManagerException

Returns the issue associated with the given unique issue ID. If no such issue exists, then null is returned. Note that the returned element is a non-editable version of the issue.

Throws:

ProblemManagerException

editIssue

public IEditableIssue editIssue(IIssue issue)
                         throws ProblemManagerException

Given the real issue, returns the editable version of the issue.

Throws:

ProblemManagerException

createIssue

public IEditableIssue createIssue(java.lang.String type)
                           throws ProblemManagerException

Creates a new issue of the given type. If type is null, then a new issue of the default issue type is created and returned.

Throws:

ProblemManagerException

getProblemManagerInfo

public IProblemManagerInfo getProblemManagerInfo()

Returns all meta-data for this problem management tracker.