net.serenitybdd.plugins.jira.model.IssueTracker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of serenity-jira-plugin Show documentation

There is a newer version: 4.2.9

package net.serenitybdd.plugins.jira.model;

import net.serenitybdd.plugins.jira.domain.IssueComment;
import net.serenitybdd.plugins.jira.service.JIRAConnection;

import java.util.List;

/**
 * An interface to an issue tracking system.
 * Should allow a client to connect to an issue tracking system, retrieve comments for an existing issue, and
 * add new comments.
 */
public interface IssueTracker {
    /**
     * Add a new comment to the specified issue in the remote issue tracking system.
     * @param issueKey the unique key identifying the issue to be commented.
     * @param commentText  text of the comment.
     */
    void addComment(final String issueKey, final String commentText) throws IssueTrackerUpdateException;

    List getCommentsFor(final String issueKey) throws IssueTrackerUpdateException;

    void updateComment(final String issueKey,final IssueComment issueComment);

    public String getStatusFor(final String issueKey) throws IssueTrackerUpdateException;

    public void doTransition(final String issueKey, final String status) throws IssueTrackerUpdateException;
    
    public JIRAConnection getJiraConnection();
}