com.segue.scc.published.api.issuetracking

Class IssueTrackingField

java.lang.Object

com.segue.scc.published.api.issuetracking.IssueTrackingField

public class IssueTrackingField
extends java.lang.Object

The IssueTrackingField describes one of the input fields that will be displayed in the GUI when an Issue is created (or altered). Fields may have a predefined list of values to select (e.g. fields of type SELECT_FIELD) or free text to enter. Fields may depend on each other which means that the values of one field can depend on the selected value of another field.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BROWSE_FILE_FIELD
static int	BROWSE_FOLDER_FIELD
static int	CHECKBOX Check-box field.
static int	DATE_FIELD For later version.
static int	INT_FIELD For later version.
static int	LABEL_NO_FIELD Only a label without any input data.
static int	MULTI_SELECT For later version.
static int	OPEN_MULTI_SELECT For later version.
static int	OPEN_SELECT_FIELD The user may select an item from the choice list or type in a new value.
static int	SELECT_FIELD Single-line SelectBox.
static int	TEXTAREA Multi-line free text.
static int	TEXTFIELD Single-line free text.

Constructor Summary

Constructors

Constructor and Description
IssueTrackingField(java.lang.String name, int type, java.lang.String[] value, java.lang.String[] options, java.lang.String label, boolean required, int maxLength, boolean visible)
IssueTrackingField(java.lang.String name, int type, java.lang.String value, java.lang.String[] options, java.lang.String label, boolean required, int maxLength)
IssueTrackingField(java.lang.String name, int type, java.lang.String value, java.lang.String[] options, java.lang.String label, boolean isRequired, int maxLength, boolean visible)
IssueTrackingField(java.lang.String name, int type, java.lang.String value, java.lang.String[] options, java.lang.String label, int maxLength, boolean visible)

Method Summary

Modifier and Type	Method and Description
void	addDependentField(IssueTrackingField field) Add a field whose value depends on the value of this field.
java.util.List<IssueTrackingField>	getDependentFields() Get all fields that depend on this field.
int	getFieldLength() The maximum number of characters the user may enter.
java.lang.String	getLabel() The label that will be displayed in the GUI.
java.lang.String	getName() A unique name for internal use.
java.lang.String[]	getOptions()
int	getType() one of SELECT_FIELD, TEXTFIELD, TEXTAREA, CHECKBOX, DATE_FIELD, INT_FIELD, MULTI_SELECT, OPEN_MULTI_SELECT, OPEN_SELECT_FIELD.
java.lang.String	getValue() Get the entered/set value of this field.
java.lang.String[]	getValues() Get values from fields with multi-select values.
boolean	hasDependentFields()
boolean	isRequired() Specifies if the user has to enter a value for the field.
boolean	isVisible() Invisible fields are not displayed in the GUI, but can contain any data.
void	setFieldLength(int fieldLength)
void	setLabel(java.lang.String label) Set the label shown in the GUI for this field.
void	setName(java.lang.String name)
void	setOptions(java.lang.String[] options)
void	setRequired(boolean required) Set if a value has to be entered for this field.
void	setType(int type)
void	setValue(java.lang.String value) Set the value of this field.
void	setValue(java.lang.String[] values) Set selected values for multi-select fields.
void	setVisible(boolean visible)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SELECT_FIELD

public static final int SELECT_FIELD

Single-line SelectBox.

See Also:

Constant Field Values

CHECKBOX

public static final int CHECKBOX

Check-box field.

See Also:

Constant Field Values

TEXTFIELD

public static final int TEXTFIELD

Single-line free text.

See Also:

Constant Field Values

TEXTAREA

public static final int TEXTAREA

Multi-line free text. For later version. Currently handled as TEXTFIELD.

See Also:

Constant Field Values

MULTI_SELECT

public static final int MULTI_SELECT

For later version. Currently handled as SELECT_FIELD.

See Also:

Constant Field Values

INT_FIELD

public static final int INT_FIELD

For later version. Currently handled as TEXTFIELD.

See Also:

Constant Field Values

DATE_FIELD

public static final int DATE_FIELD

For later version. Currently handled as TEXTFIELD.

See Also:

Constant Field Values

OPEN_SELECT_FIELD

public static final int OPEN_SELECT_FIELD

The user may select an item from the choice list or type in a new value. For later version. Currently handled as SELECT_FIELD.

See Also:

Constant Field Values

OPEN_MULTI_SELECT

public static final int OPEN_MULTI_SELECT

For later version. Currently handled as SELECT_FIELD.

See Also:

Constant Field Values

BROWSE_FOLDER_FIELD

public static final int BROWSE_FOLDER_FIELD

See Also:

Constant Field Values

BROWSE_FILE_FIELD

public static final int BROWSE_FILE_FIELD

See Also:

Constant Field Values

LABEL_NO_FIELD

public static final int LABEL_NO_FIELD

Only a label without any input data. Designed to be used as headline.

See Also:

Constant Field Values

Constructor Detail

IssueTrackingField

public IssueTrackingField(java.lang.String name,
                          int type,
                          java.lang.String value,
                          java.lang.String[] options,
                          java.lang.String label,
                          boolean required,
                          int maxLength)

IssueTrackingField

public IssueTrackingField(java.lang.String name,
                          int type,
                          java.lang.String value,
                          java.lang.String[] options,
                          java.lang.String label,
                          int maxLength,
                          boolean visible)

IssueTrackingField

public IssueTrackingField(java.lang.String name,
                          int type,
                          java.lang.String value,
                          java.lang.String[] options,
                          java.lang.String label,
                          boolean isRequired,
                          int maxLength,
                          boolean visible)

IssueTrackingField

public IssueTrackingField(java.lang.String name,
                          int type,
                          java.lang.String[] value,
                          java.lang.String[] options,
                          java.lang.String label,
                          boolean required,
                          int maxLength,
                          boolean visible)

Parameters:

name - A unique name for the field (ID).

type - The type of the field.

value - The current value of the field.

options - The options for a field with selectable values.

label - The label for the field shown in the dialog.

required - Defines if the user has to enter a value for this field or if it can be left blank.

maxLength - The maximum number of characters that can be entered in a TextField or TextArea .

visible - Invisible fields are not displayed in the GUI, but can contain any data.

Method Detail

getName

public java.lang.String getName()

A unique name for internal use. This is usually the name of the field in the integrated issue tracking system.

setName

public void setName(java.lang.String name)

getType

public int getType()

one of SELECT_FIELD, TEXTFIELD, TEXTAREA, CHECKBOX, DATE_FIELD, INT_FIELD, MULTI_SELECT, OPEN_MULTI_SELECT, OPEN_SELECT_FIELD.

setType

public void setType(int type)

getValues

public java.lang.String[] getValues()

Get values from fields with multi-select values.

Returns:

setValue

public void setValue(java.lang.String[] values)

Set selected values for multi-select fields.

Parameters:

values -

getValue

public java.lang.String getValue()

Get the entered/set value of this field.

Returns:

The entered/set value of this field.

setValue

public void setValue(java.lang.String value)

Set the value of this field.

Parameters:

value -

getLabel

public java.lang.String getLabel()

The label that will be displayed in the GUI.

setLabel

public void setLabel(java.lang.String label)

Set the label shown in the GUI for this field.

Parameters:

label - The label shown in the GUI for this field.

isRequired

public boolean isRequired()

Specifies if the user has to enter a value for the field. If false, entering a value is optional.

setRequired

public void setRequired(boolean required)

Set if a value has to be entered for this field.

Parameters:

required -

getFieldLength

public int getFieldLength()

The maximum number of characters the user may enter. The GUI will limit the length of the field to this value.

setFieldLength

public void setFieldLength(int fieldLength)

Parameters:

fieldLength - The maximum number of characters the user may enter.

getOptions

public java.lang.String[] getOptions()

Returns:

the selectable options for a field with type SELECT_FIELD.

setOptions

public void setOptions(java.lang.String[] options)

Parameters:

options - the selectable options for a field with type SELECT_FIELD.

addDependentField

public void addDependentField(IssueTrackingField field)

Add a field whose value depends on the value of this field. This field has to be type SELECT_FIELD.

Parameters:

field - that should be updated if the value changes.

hasDependentFields

public boolean hasDependentFields()

Returns:

true if dependent fields have been added to this field.

getDependentFields

public java.util.List<IssueTrackingField> getDependentFields()

Get all fields that depend on this field.

Returns:

a list of IssueTrackingFields depending on this field.

isVisible

public boolean isVisible()

Invisible fields are not displayed in the GUI, but can contain any data.

setVisible

public void setVisible(boolean visible)