flexagon.fd.model.integration.its.api

Class IssueTrackingSystem

java.lang.Object

flexagon.fd.model.integration.its.api.IssueTrackingSystem

public abstract class IssueTrackingSystem
extends java.lang.Object

Implementation base for each ITS (e.g. Jira)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.io.Serializable>	mProperties

Constructor Summary

Constructors

Constructor and Description
IssueTrackingSystem()

Method Summary

Modifier and Type	Method and Description
void	addAttachmentToWorkItem(WorkItem ticket, WorkItemAttachmentUpload attachment) Adds an attachment to a ticket
abstract void	addCommentToWorkItem(WorkItem ticket, java.lang.String comment) Adds a comment to a ticket.
void	addCommentToWorkItem(WorkItem ticket, java.lang.String comment, java.util.List<WorkItemAttachmentUpload> attachments) Adds a comment with attachments to a ticket.
abstract void	changeWorkItemStatusTo(WorkItem ticket, java.io.Serializable status) Status is id value as entered on Status tab.
abstract void	checkConnection() Check connection using details provided in getProperties().
abstract java.util.List<WorkItemStatus>	getAvailableWorkItemStatuses(WorkItem ticket)
java.lang.String	getIssueTrackingSystemName()
abstract java.util.List<IssueTrackingSystemInstanceProject>	getProjects()
java.util.Map<java.lang.String,java.io.Serializable>	getProperties()
abstract WorkItemDetails	getWorkItem(WorkItem ticket)
abstract WorkItemAttachmentContent	getWorkItemAttachmentContent(WorkItem ticket, java.io.Serializable attachmentId)
WorkItemAllowedAttachmentLocation	getWorkItemAttachmentLocation() Return the allowed locations for work item attachments
abstract java.util.Collection<WorkItemAttachment>	getWorkItemAttachments(WorkItem ticket)
abstract java.util.Collection<WorkItemComment>	getWorkItemComments(WorkItem ticket, int offset, int limit)
abstract java.util.Collection<WorkItemUpdate>	getWorkItemHistory(WorkItem ticket, int offset, int limit)
abstract java.util.List<WorkItemDetails>	getWorkItems(java.util.List<WorkItem> workItems)
abstract java.lang.String	getWorkItemStatus(WorkItem ticket) Return Status Name as String.
abstract java.lang.String	getWorkItemURL(WorkItem ticket) Return ticket's absolute URL.
boolean	isExternalSearchExcludeKeysSupported()
boolean	isExternalSearchFilterRequired()
boolean	isExternalSearchProjectRequired()
boolean	isExternalSearchProjectSupported()
boolean	isExternalSearchSupported()
abstract java.util.Collection<java.lang.String>	parseWorkItemNumberFromChangeLogs(java.util.List<java.lang.String> pMessagesToParse, java.util.List<java.lang.String> pTicketPatternList) Provides a valid Issue Tracking System number by parsing the ticketNumber using the pattern
abstract void	populateWorkItem(WorkItem ticket) Populates ticket's data (e.g.
abstract java.util.List<WorkItemSearchResult>	searchWorkItems(WorkItemSearchInput pInput) Searches for work items in ITS matching a filter and project Can optionally provide a release id for filtering out work items already in release, or a list of work item numbers to exclude from results
void	setIssueTrackingSystemName(java.lang.String pIssueTrackingSystemName)
void	setProperties(java.util.Map<java.lang.String,java.io.Serializable> pProperties)

Methods inherited from class java.lang.Object

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

Field Detail

mProperties

protected java.util.Map<java.lang.String,java.io.Serializable> mProperties

Constructor Detail

IssueTrackingSystem

public IssueTrackingSystem()

Method Detail

setIssueTrackingSystemName

public void setIssueTrackingSystemName(java.lang.String pIssueTrackingSystemName)

getIssueTrackingSystemName

public java.lang.String getIssueTrackingSystemName()

setProperties

public void setProperties(java.util.Map<java.lang.String,java.io.Serializable> pProperties)

getProperties

public java.util.Map<java.lang.String,java.io.Serializable> getProperties()

populateWorkItem

public abstract void populateWorkItem(WorkItem ticket)
                               throws ApiException

Populates ticket's data (e.g. Description and Type) by invoking setDescription and setType on supplied ticket object.

Parameters:

ticket -

Throws:

ApiException

getWorkItemURL

public abstract java.lang.String getWorkItemURL(WorkItem ticket)
                                         throws ApiException

Return ticket's absolute URL. You can use getProperties() details along with ticket object (number, type, description) to determine URL. This used on FlexDeploy UI when tickets are linked with project version.

Parameters:

ticket -

Returns:

Throws:

ApiException

addCommentToWorkItem

public abstract void addCommentToWorkItem(WorkItem ticket,
                                          java.lang.String comment)
                                   throws ApiException

Adds a comment to a ticket.

Parameters:

ticket -

comment -

Throws:

ApiException

getWorkItemAttachmentLocation

public WorkItemAllowedAttachmentLocation getWorkItemAttachmentLocation()

Return the allowed locations for work item attachments

Returns:

addCommentToWorkItem

public void addCommentToWorkItem(WorkItem ticket,
                                 java.lang.String comment,
                                 java.util.List<WorkItemAttachmentUpload> attachments)
                          throws ApiException

Adds a comment with attachments to a ticket.

Parameters:

ticket -

comment -

Throws:

ApiException

addAttachmentToWorkItem

public void addAttachmentToWorkItem(WorkItem ticket,
                                    WorkItemAttachmentUpload attachment)
                             throws ApiException

Adds an attachment to a ticket

Parameters:

ticket -

attachment -

Throws:

ApiException

changeWorkItemStatusTo

public abstract void changeWorkItemStatusTo(WorkItem ticket,
                                            java.io.Serializable status)
                                     throws ApiException

Status is id value as entered on Status tab. Implementation should update status of ticket to supplied id value.

Parameters:

ticket -

status -

Throws:

ApiException

getWorkItemStatus

public abstract java.lang.String getWorkItemStatus(WorkItem ticket)
                                            throws ApiException

Return Status Name as String. This should be Name value that is entered on Status tab.

Parameters:

ticket -

Returns:

Throws:

ApiException

checkConnection

public abstract void checkConnection()
                              throws ApiException

Check connection using details provided in getProperties(). If connection can not be established throw ApiException with appropriate error message.

Throws:

ApiException

parseWorkItemNumberFromChangeLogs

public abstract java.util.Collection<java.lang.String> parseWorkItemNumberFromChangeLogs(java.util.List<java.lang.String> pMessagesToParse,
                                                                                         java.util.List<java.lang.String> pTicketPatternList)
                                                                                  throws ApiException

Provides a valid Issue Tracking System number by parsing the ticketNumber using the pattern

Parameters:

pMessagesToParse -

pTicketPatternList -

Returns:

Throws:

ApiException

getWorkItem

public abstract WorkItemDetails getWorkItem(WorkItem ticket)
                                     throws ApiException

Throws:

ApiException

getWorkItems

public abstract java.util.List<WorkItemDetails> getWorkItems(java.util.List<WorkItem> workItems)
                                                      throws ApiException

Throws:

ApiException

getWorkItemComments

public abstract java.util.Collection<WorkItemComment> getWorkItemComments(WorkItem ticket,
                                                                          int offset,
                                                                          int limit)
                                                                   throws ApiException

Throws:

ApiException

getWorkItemHistory

public abstract java.util.Collection<WorkItemUpdate> getWorkItemHistory(WorkItem ticket,
                                                                        int offset,
                                                                        int limit)
                                                                 throws ApiException

Throws:

ApiException

getWorkItemAttachments

public abstract java.util.Collection<WorkItemAttachment> getWorkItemAttachments(WorkItem ticket)
                                                                         throws ApiException

Throws:

ApiException

getWorkItemAttachmentContent

public abstract WorkItemAttachmentContent getWorkItemAttachmentContent(WorkItem ticket,
                                                                       java.io.Serializable attachmentId)
                                                                throws ApiException

Throws:

ApiException

getAvailableWorkItemStatuses

public abstract java.util.List<WorkItemStatus> getAvailableWorkItemStatuses(WorkItem ticket)
                                                                     throws ApiException

Throws:

ApiException

searchWorkItems

public abstract java.util.List<WorkItemSearchResult> searchWorkItems(WorkItemSearchInput pInput)
                                                              throws ApiException

Searches for work items in ITS matching a filter and project Can optionally provide a release id for filtering out work items already in release, or a list of work item numbers to exclude from results

Parameters:

pInput -

Returns:

A paginated list of work items

Throws:

ApiException

getProjects

public abstract java.util.List<IssueTrackingSystemInstanceProject> getProjects()
                                                                        throws ApiException

Throws:

ApiException

isExternalSearchSupported

public boolean isExternalSearchSupported()
                                  throws ApiException

Throws:

ApiException

isExternalSearchExcludeKeysSupported

public boolean isExternalSearchExcludeKeysSupported()
                                             throws ApiException

Throws:

ApiException

isExternalSearchProjectRequired

public boolean isExternalSearchProjectRequired()
                                        throws ApiException

Throws:

ApiException

isExternalSearchProjectSupported

public boolean isExternalSearchProjectSupported()
                                         throws ApiException

Throws:

ApiException

isExternalSearchFilterRequired

public boolean isExternalSearchFilterRequired()
                                       throws ApiException

Throws:

ApiException