com.atlassian.jira.functest.framework.navigation
Interface IssueNavigation

All Known Implementing Classes:

IssueNavigationImpl

public interface IssueNavigation

Navigate issue functionality

Since:

v3.13

Method Summary

void	addComment(String issueKey, String comment) Adds a comment on the given issue, making it visible to all the users who can see the issue.
void	addComment(String issueKey, String comment, String roleLevel) Adds a comment on the given issue visible only to members the given role.
IssueNavigation	addWatchers(String issueKey, String... usernames) Add watchers to an issue.
void	assignIssue(String issueKey, String comment, String userFullName) Assign this issue to a different user.
void	assignIssue(String issueKey, String userFullName, String comment, String commentLevel) Assign an issue to a user.
AttachmentsBlock	attachments(String issueKey) Returns a representation of the attachments block on the view issue page for a specific issue.
void	closeIssue(String issueKey, String resolution, String comment) Closes an issue with the given resolution.
String	createIssue(String projectName, String issueType, String summary) Creates a new issue for the given project and returns the created issue key Assumes that the schemes are such that summary is the only required field
String	createIssue(String projectName, String issueType, String summary, Map<String,String[]> params) Creates a new issue for the given project and returns the created issue key
String	createSubTask(String parentIssueKey, String subTaskType, String subTaskSummary, String subTaskDescription) Creates a new sub task for the given parent issue and returns the created issue key Assumes that the schemes are such that summary is the only required field.
String	createSubTask(String parentIssueKey, String subTaskType, String subTaskSummary, String subTaskDescription, String originalEstimate) Creates a new sub task for the given parent issue and returns the created issue key Assumes that the schemes are such that summary is the only required field.
void	deleteIssue(String issueKey) Deletes the specific issue.
IssueNavigation	editCustomLabels(int issueId, int customFieldId) Edit custom labels of the issue.
IssueNavigation	editLabels(int issueId) Go to edit labels of the issue.
String	getId(String issueKey) Gets the id of an issue.
void	goToCreateIssueForm(String projectName, String issueType) Goes to the create issue form.
void	gotoEditIssue(long issueId) Navigates straight to the Edit screen of a specific issue, bypassing the View screen.
void	gotoEditIssue(String issueKey) Navigates to the Edit screen of a specific issue.
void	gotoIssue(String issueKey) Navigates to the the issue provided
void	gotoIssueChangeHistory(String issueKey) Navigates to the change history tab of the issue provided
void	gotoIssueWorkLog(String issueKey) Navigates to the work log tab of the issue provided
void	logWork(String issueKey, String timeLogged) Log work against an issue
void	logWork(String issueKey, String timeLogged, String newEstimate) Logs work on the issue with the given key.
void	logWorkWithComment(String issueKey, String timeLogged, String comment) Logs work on the issue with the given key.
void	reopenIssue(String issueKey) Reopens a resolved issue.
void	resolveIssue(String issueKey, String resolution, String comment) Resolves an issue with the given resolution.
void	resolveIssue(String issueKey, String resolution, String comment, String originalEstimate, String remainingEstimate) Resolves an issue with the given resolution.
IssueNavigatorNavigation	returnToSearch() Deprecated.
void	setAffectsVersions(String issueKey, String... affectsVersions) Sets the given affects versions on the selected issue.
void	setComponents(String issueKey, String... components) Sets the given components on the selected issue.
void	setDescription(String issueKey, String description) Sets the description field on the given issue.
void	setDueDate(String issueKey, String dateString) Sets the due date for an issue to the date string passed in
void	setEnvironment(String issueKey, String environment) Sets the environment field on the given issue.
void	setEstimates(String issueKey, String originalEstimate, String remainingEstimate) Sets the original and remaining estimate on an issue and submits this change.
void	setFixVersions(String issueKey, String... fixVersions) Sets the given fix versions on the selected issue.
void	setFreeTextCustomField(String issueKey, String customFieldId, String text) Sets the description field on the given issue.
void	setIssueMultiSelectField(String issueKey, String fieldId, String... options) Sets the multi-select field to the options
void	setOriginalEstimate(String issueKey, String newValue) Sets the original estimate on an issue and submits this change.
void	setPriority(String issueKey, String priority) Sets the priority of the given issue
void	setRemainingEstimate(String issueKey, String newValue) Sets the remaining estimate on an issue and submits this change.
void	unassignIssue(String issueKey, String comment) Unassign an issue.
void	unassignIssue(String issueKey, String comment, String commentLevel) Un-assign an issue.
void	unvoteIssue(String issueKey) Removes the user's vote for the issue.
void	unwatchIssue(String issueKey) Unwatches the issue for the current user.
ViewIssuePage	viewIssue(String issueKey) Navigates to a specific issue.
void	viewPrintable(String issueKey) Navigates to a specific issues printable view.
void	viewXml(String issueKey) Navigates to a specific issue's XML view.
void	voteIssue(String issueKey) Add the user's vote for the issue
void	watchIssue(String issueKey) Starts watching an issue if not already watched.

Method Detail

viewIssue

ViewIssuePage viewIssue(String issueKey)

Navigates to a specific issue.

Parameters:

issueKey - key of issue

viewPrintable

void viewPrintable(String issueKey)

Navigates to a specific issues printable view.

Parameters:

issueKey - key of issue

viewXml

void viewXml(String issueKey)

Navigates to a specific issue's XML view.

Parameters:

issueKey - key of issue

gotoEditIssue

void gotoEditIssue(String issueKey)

Navigates to the Edit screen of a specific issue.

Parameters:

issueKey - key of issue

gotoEditIssue

void gotoEditIssue(long issueId)

Navigates straight to the Edit screen of a specific issue, bypassing the View screen.

Parameters:

issueId - id of issue

deleteIssue

void deleteIssue(String issueKey)

Deletes the specific issue.

Parameters:

issueKey - issue key

gotoIssue

void gotoIssue(String issueKey)

Navigates to the the issue provided

Parameters:

issueKey - The issuekey to navigate to.

gotoIssueChangeHistory

void gotoIssueChangeHistory(String issueKey)

Navigates to the change history tab of the issue provided

Parameters:

issueKey - The issuekey to navigate to.

gotoIssueWorkLog

void gotoIssueWorkLog(String issueKey)

Navigates to the work log tab of the issue provided

Parameters:

issueKey - The issuekey to navigate to.

createIssue

String createIssue(@Nullable
                   String projectName,
                   @Nullable
                   String issueType,
                   String summary)

Creates a new issue for the given project and returns the created issue key

Assumes that the schemes are such that summary is the only required field

Parameters:

projectName - the project name - can be null and hence assume default

issueType - the issue type - can be null and hence assume default

summary - a summary for the issue

Returns:

the newly created issue key

createIssue

String createIssue(String projectName,
                   String issueType,
                   String summary,
                   Map<String,String[]> params)

Creates a new issue for the given project and returns the created issue key

Parameters:

projectName - the project name - can be null and hence assume default

issueType - the issue type - can be null and hence assume default

summary - a summary for the issue

params - a map containing any optional params to add to the issue

Returns:

the newly created issue key

createSubTask

String createSubTask(String parentIssueKey,
                     String subTaskType,
                     String subTaskSummary,
                     String subTaskDescription)

Creates a new sub task for the given parent issue and returns the created issue key

Assumes that the schemes are such that summary is the only required field.

Note: if sub tasks are not enabled, they will be enabled before attempting to create the sub task.

Parameters:

parentIssueKey - the parent issue

subTaskType - the sub task type

subTaskSummary - the summary

subTaskDescription - the description; use null to omit this field

Returns:

the newly created issue key

createSubTask

String createSubTask(String parentIssueKey,
                     String subTaskType,
                     String subTaskSummary,
                     String subTaskDescription,
                     String originalEstimate)

Creates a new sub task for the given parent issue and returns the created issue key

Assumes that the schemes are such that summary is the only required field.

Note: if sub tasks are not enabled, they will be enabled before attempting to create the sub task.

Parameters:

parentIssueKey - the parent issue

subTaskType - the sub task type

subTaskSummary - the summary

subTaskDescription - the description; use null to omit this field

originalEstimate - original estimate for time tracking field; may be left null

Returns:

the newly created issue key

setComponents

void setComponents(String issueKey,
                   String... components)

Sets the given components on the selected issue.

Parameters:

issueKey - issue key

components - components

setEnvironment

void setEnvironment(String issueKey,
                    String environment)

Sets the environment field on the given issue.

Parameters:

issueKey - issue key

environment - the text

setDescription

void setDescription(String issueKey,
                    String description)

Sets the description field on the given issue.

Parameters:

issueKey - issue key

description - the text

setFreeTextCustomField

void setFreeTextCustomField(String issueKey,
                            String customFieldId,
                            String text)

Sets the description field on the given issue.

Parameters:

issueKey - issue key

customFieldId - the id of the custom field to set e.g. customfield_10000

text - the text

setPriority

void setPriority(String issueKey,
                 String priority)

Sets the priority of the given issue

Parameters:

issueKey - issue key

priority - the Displayed priority value

assignIssue

void assignIssue(String issueKey,
                 String comment,
                 String userFullName)

Assign this issue to a different user.

Parameters:

issueKey - The issue key of the issue to be assigned.

comment - The comment to be added when assigning the specified issue.

userFullName - the full name of the user this should be assigned to.

assignIssue

void assignIssue(String issueKey,
                 String userFullName,
                 String comment,
                 String commentLevel)

Assign an issue to a user.

Parameters:

issueKey - The issue key of the issue to be assigned.

userFullName - The full name of the user the issue will be assigned to.

comment - The comment to be added when assigning the specified issue.

commentLevel - The group or role that will be able to view the specified comment.

unassignIssue

void unassignIssue(String issueKey,
                   String comment)

Unassign an issue. Note: assumes unassigned issues are allowed.

Parameters:

issueKey - The issue key of the issue to be un-assigned.

comment - The comment to be added when un-assigning the specified issue.

unassignIssue

void unassignIssue(String issueKey,
                   String comment,
                   String commentLevel)

Un-assign an issue. Note: assumes un-assigned issues are allowed.

Parameters:

issueKey - The issue key of the issue to be un-assigned.

comment - The comment to be added when un-assigning the specified issue.

commentLevel - The group or role that will be able to view the specified comment.

setFixVersions

void setFixVersions(String issueKey,
                    String... fixVersions)

Sets the given fix versions on the selected issue.

Parameters:

issueKey - issue key

fixVersions - the names of the versions e.g. New Version 4

setAffectsVersions

void setAffectsVersions(String issueKey,
                        String... affectsVersions)

Sets the given affects versions on the selected issue.

Parameters:

issueKey - issue key

affectsVersions - the names of the versions e.g. New Version 4

setIssueMultiSelectField

void setIssueMultiSelectField(String issueKey,
                              String fieldId,
                              String... options)

Sets the multi-select field to the options

Parameters:

issueKey - issue key

fieldId - the id of the field e.g. customfield_10000

options - the named options, not the values

addComment

void addComment(String issueKey,
                String comment)

Adds a comment on the given issue, making it visible to all the users who can see the issue.

Parameters:

issueKey - The issue key.

comment - The body of the comment to be added.

addComment

void addComment(String issueKey,
                String comment,
                String roleLevel)

Adds a comment on the given issue visible only to members the given role.

Parameters:

issueKey - The issue key.

comment - The body of the comment to be added.

roleLevel - role level; use null to not select any role level.

logWork

void logWork(String issueKey,
             String timeLogged)

Log work against an issue

Parameters:

issueKey - the issue to work against

timeLogged - the duration string (i.e. "2h") representing the work don

reopenIssue

void reopenIssue(String issueKey)

Reopens a resolved issue.

Parameters:

issueKey - the issue key to reopen.

unwatchIssue

void unwatchIssue(String issueKey)

Unwatches the issue for the current user.

Parameters:

issueKey - the issue key

unvoteIssue

void unvoteIssue(String issueKey)

Removes the user's vote for the issue. Note: you can only remove your vote for an issue if it is not resolved.

Parameters:

issueKey - the issue key

voteIssue

void voteIssue(String issueKey)

Add the user's vote for the issue

Parameters:

issueKey - the issue key

watchIssue

void watchIssue(String issueKey)

Starts watching an issue if not already watched.

Parameters:

issueKey - the issue to watch

addWatchers

IssueNavigation addWatchers(String issueKey,
                            String... usernames)

Add watchers to an issue.

Parameters:

issueKey - key of the issue

usernames - usernames of users to add as watchers

Returns:

this issue navigation instance

logWork

void logWork(String issueKey,
             String timeLogged,
             String newEstimate)

Logs work on the issue with the given key.

Parameters:

issueKey - the key of the issue to log work on.

timeLogged - formatted time spent e.g. 1h 30m.

newEstimate - formatted new estimate e.g. 1d 2h.

logWorkWithComment

void logWorkWithComment(String issueKey,
                        String timeLogged,
                        String comment)

Logs work on the issue with the given key.

Parameters:

issueKey - the key of the issue to log work on.

timeLogged - formatted time spent e.g. 1h 30m.

comment - comment to add while logging the work

goToCreateIssueForm

void goToCreateIssueForm(@Nullable
                         String projectName,
                         @Nullable
                         String issueType)

Goes to the create issue form.

Parameters:

projectName - The project for the issue to be created in the form.

issueType - The issue type for the issue to be created in the form.

setOriginalEstimate

void setOriginalEstimate(String issueKey,
                         String newValue)

Sets the original estimate on an issue and submits this change.

NOTE:This method assumes time tracking is enabled

Parameters:

issueKey - The issue that the original estimate will be set on.

newValue - The value to set as the original estimate.

setRemainingEstimate

void setRemainingEstimate(String issueKey,
                          String newValue)

Sets the remaining estimate on an issue and submits this change.

NOTE:This method assumes time tracking is enabled

Parameters:

issueKey - The issue that the remaining estimate will be set on.

newValue - The value to set as the remaining estimate.

setEstimates

void setEstimates(String issueKey,
                  String originalEstimate,
                  String remainingEstimate)

Sets the original and remaining estimate on an issue and submits this change.

NOTE:This method assumes time tracking is enabled

Parameters:

issueKey - The issue that the remaining estimate will be set on.

originalEstimate - The value to set as the original estimate.

remainingEstimate - The value to set as the remaining estimate.

resolveIssue

void resolveIssue(String issueKey,
                  String resolution,
                  String comment,
                  String originalEstimate,
                  String remainingEstimate)

Resolves an issue with the given resolution.

NOTE:This method assumes time tracking is enabled

Parameters:

issueKey - the issue key to resolve.

resolution - the name of the resolution. e.g. Fixed. Case sensitive!

comment - a comment to add

originalEstimate - The value to set as the original estimate.

remainingEstimate - The value to set as the remaining estimate.

resolveIssue

void resolveIssue(String issueKey,
                  String resolution,
                  String comment)

Resolves an issue with the given resolution.

Parameters:

issueKey - the issue key to resolve.

resolution - the name of the resolution. e.g. Fixed. Case sensitive!

comment - a comment to add

setDueDate

void setDueDate(String issueKey,
                String dateString)

Sets the due date for an issue to the date string passed in

Parameters:

issueKey -

dateString -

closeIssue

void closeIssue(String issueKey,
                String resolution,
                String comment)

Closes an issue with the given resolution.

Parameters:

issueKey - the issue key to resolve.

resolution - the name of the resolution. e.g. Fixed. Case sensitive!

comment - a comment to add

attachments

AttachmentsBlock attachments(String issueKey)

Returns a representation of the attachments block on the view issue page for a specific issue.

Parameters:

issueKey - the key of the issue.

Returns:

An AttachmentsBlock for the provided issue key.

editLabels

IssueNavigation editLabels(int issueId)

Go to edit labels of the issue.

Parameters:

issueId - Id of the issue

Returns:

this issue navigation instance

editCustomLabels

IssueNavigation editCustomLabels(int issueId,
                                 int customFieldId)

Edit custom labels of the issue.

Parameters:

issueId - ID of the issue

customFieldId - ID of the labels custom field

Returns:

this issue navigation instance

returnToSearch

IssueNavigatorNavigation returnToSearch()

Deprecated.

As of JIRA 6.0, issue pager is rendered client side. It is no longer possible to generate these issue pagers on page request and thus it is not possible to have this return-to-search link on the page. This method will simply navigate to issue navigator with jql="". You can either use the mentioned behaviour or either re-execute the search with the wanted JQL

Returns:

an issue navigator navigation instance

getId

String getId(String issueKey)

Gets the id of an issue.

Parameters:

issueKey - The key of the issue in play.

Returns:

A String containing the issue's id.