net.sourceforge.groboutils.pmti.v1
Interface IIssueState

All Known Subinterfaces:

IEditableIssueState

All Known Implementing Classes:

DefaultEditableIssueState, DefaultIssueState

public interface IIssueState

Describes the state of an Issue. Issue states may have additional information associated with them, and as such uses the Attribute methodology in the same way an Issue does. All implementations of IIssueState must be immutable, unless they are also instances of IEditableIssueState.

Since:

July 7, 2002

Version:

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

Author:

Matt Albrecht groboclown@users.sourceforge.net

Method Summary

IAttributeSet	getAttributes() Returns a list of all attributes associated with this state.
java.lang.String	getDescription() Retrieves a long, human-readable, description of the state.
java.lang.String	getName() Returns the short name of the state.
boolean	isClosed() A broad category for the state - it means that the issue has been resolved, and the code is no longer open for changes based on this issue.
boolean	isOpen() A broad category for the state - it means that the issue has not been resolved yet, and the code is still open for changes based on this issue.

Method Detail

getName

public java.lang.String getName()

Returns the short name of the state.

Returns:

the short readable name of the state.

getDescription

public java.lang.String getDescription()

Retrieves a long, human-readable, description of the state.

Returns:

the state's description.

isOpen

public boolean isOpen()

A broad category for the state - it means that the issue has not been resolved yet, and the code is still open for changes based on this issue.

isOpen() must always return the opposite of isClosed(); that is, the following code:

      isOpen() == !isClosed()
 

must always evaluate to true.

isClosed

public boolean isClosed()

A broad category for the state - it means that the issue has been resolved, and the code is no longer open for changes based on this issue.

isClosed() must always return the opposite of isOpen(); that is, the following code:

      isOpen() == !isClosed()
 

must always evaluate to true.

getAttributes

public IAttributeSet getAttributes()

Returns a list of all attributes associated with this state. All states of a particular type should have the same set of issues. If the problem tracker does not have attributes associated with an issue state, then this must still return a non-null, but the set will be empty.

Returns:

the set of tracker-specific and issue type-specific attributes and values associated with this issue. Can never return null.