com.segue.scc.published.api.issuetracking

Class Issue

java.lang.Object

com.segue.scc.published.api.issuetracking.Issue

public abstract class Issue
extends java.lang.Object

The issue is the object the system interacts with. The issue knows the properties it has.
To show a value as "Priority" in the SilkCentral UI (e.g. in the Issues tab of a test), add a field with the name FIELD_PRIORITY and assign the appropriate value.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_PRIORITY
protected IssueTrackingField[]	mFields

Constructor Summary

Constructors

Constructor and Description
Issue()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getDescription()
IssueTrackingField[]	getFields() Get the fields of an issue.
abstract java.lang.String	getId()
abstract java.lang.String	getLink()
java.lang.String[]	getMissingFields() Get the labels of the fields where an input is missing.
java.lang.String[]	getOptions(java.lang.String fieldname) Get the options of a field with selectable values.
abstract java.lang.String	getStatus()
abstract java.lang.String	getSynopsis()
java.lang.String	getValue(java.lang.String fieldname) Get the value of a property.
abstract void	setDescription(java.lang.String description)
abstract void	setSynopsis(java.lang.String synopsis)
void	setValue(java.lang.String fieldname, java.lang.String value) Set the value of a property.
void	setValues(java.lang.String fieldname, java.lang.String[] value) Set the value of a property.
abstract java.lang.String	store(Credentials credentials) Stores the issue into the external issue tracking tool.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_PRIORITY

public static final java.lang.String FIELD_PRIORITY

See Also:

Constant Field Values

mFields

protected IssueTrackingField[] mFields

Constructor Detail

Issue

public Issue()

Method Detail

getFields

public IssueTrackingField[] getFields()

Get the fields of an issue.

Returns:

an array with the fields of this issue.

setValue

public void setValue(java.lang.String fieldname,
                     java.lang.String value)

Set the value of a property.

Parameters:

fieldname - the id of the field.

value - the new value of this field.

setValues

public void setValues(java.lang.String fieldname,
                      java.lang.String[] value)

Set the value of a property.

Parameters:

fieldname - the id of the field.

value - the new value of this field.

getValue

public java.lang.String getValue(java.lang.String fieldname)

Get the value of a property.

Parameters:

fieldname - the id of the field.

Returns:

the currently set value for this field.

getOptions

public java.lang.String[] getOptions(java.lang.String fieldname)

Get the options of a field with selectable values.

Parameters:

fieldname - the id of the field.

Returns:

an array of possible selections for this field.

getMissingFields

public java.lang.String[] getMissingFields()

Get the labels of the fields where an input is missing.

Returns:

the labels of the fields that are required but not entered yet.

store

public abstract java.lang.String store(Credentials credentials)
                                throws StoreIssueException

Stores the issue into the external issue tracking tool.

Parameters:

credentials - the credentials that will be used when storing this issue.

Returns:

the ID of the issue in the external issue tracking tool.

Throws:

StoreIssueException

setSynopsis

public abstract void setSynopsis(java.lang.String synopsis)

setDescription

public abstract void setDescription(java.lang.String description)

getStatus

public abstract java.lang.String getStatus()
                                    throws IssueTrackingProfileException

Returns:

the current status of the issue in the external issue tracking system.

Throws:

IssueTrackingProfileException

getId

public abstract java.lang.String getId()

Returns:

the ID of the issue in the integrated issue tracking system.

getLink

public abstract java.lang.String getLink()
                                  throws IssueTrackingProfileException

Returns:

an http link to jump directly to the instantiated issue in the external issue tracking system (if available) .

Throws:

IssueTrackingProfileException

getSynopsis

public abstract java.lang.String getSynopsis()
                                      throws IssueTrackingProfileException

Throws:

IssueTrackingProfileException

getDescription

public abstract java.lang.String getDescription()
                                         throws IssueTrackingProfileException

Throws:

IssueTrackingProfileException