com.nulabinc.backlog4j.api

Interface IssueMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface IssueMethods

Executes Backlog Issue APIs.

Method Summary

Modifier and Type	Method and Description
IssueComment	addIssueComment(AddIssueCommentParams params) Adds a issue comment.
IssueComment	addIssueCommentNotification(AddIssueCommentNotificationParams params) Adds a issue comment notification.
Issue	createIssue(CreateIssueParams params) Creates a issue.
Issue	deleteIssue(java.lang.Object issueIdOrKey) Deletes the issue.
Attachment	deleteIssueAttachment(java.lang.Object issueIdOrKey, java.lang.Object attachmentId) Deletes the attachment file on the issue.
AttachmentData	downloadIssueAttachment(java.lang.Object issueIdOrKey, java.lang.Object attachmentId) Returns the attachment file data on the issue.
Issue	getIssue(java.lang.Object issueIdOrKey) Returns the issue.
ResponseList<Attachment>	getIssueAttachments(java.lang.Object issueIdOrKey) Returns all the attachments on the issue.
IssueComment	getIssueComment(java.lang.Object issueIdOrKey, java.lang.Object commentId) Returns the issue comment.
int	getIssueCommentCount(java.lang.Object issueIdOrKey) Returns the count of the issue comments.
ResponseList<Notification>	getIssueCommentNotifications(java.lang.Object issueIdOrKey, java.lang.Object commentId) Returns the issue comment notifications.
ResponseList<IssueComment>	getIssueComments(java.lang.Object issueIdOrKey) Returns the issue comments.
ResponseList<IssueComment>	getIssueComments(java.lang.Object issueIdOrKey, QueryParams queryParams) Returns the issue comments.
ResponseList<Issue>	getIssues(GetIssuesParams params) Finds and returns all the issues.
int	getIssuesCount(GetIssuesCountParams params) Finds and returns all the issues count.
ResponseList<SharedFile>	getIssueSharedFiles(java.lang.Object issueIdOrKey) Returns all the shared files on the issue.
ResponseList<SharedFile>	linkIssueSharedFile(java.lang.Object issueIdOrKey, java.util.List fileIds) links the shared files to the issue.
SharedFile	unlinkIssueSharedFile(java.lang.Object issueIdOrKey, java.lang.Object fileId) Deletes link of the shared file from the issue.
Issue	updateIssue(UpdateIssueParams params) Updates an existing issue.
IssueComment	updateIssueComment(UpdateIssueCommentParams params) Updates an existing issue comment.

Method Detail

getIssues

ResponseList<Issue> getIssues(GetIssuesParams params)
                       throws BacklogException

Finds and returns all the issues.

Parameters:

params - the finding issue parameters

Returns:

the issues in a list.

Throws:

BacklogException

getIssuesCount

int getIssuesCount(GetIssuesCountParams params)
            throws BacklogException

Finds and returns all the issues count.

Parameters:

params - the finding issue parameters

Returns:

the issues count.

Throws:

BacklogException

createIssue

Issue createIssue(CreateIssueParams params)
           throws BacklogException

Creates a issue.

Parameters:

params - the issue creating parameters

Returns:

the created Issue

Throws:

BacklogException

getIssue

Issue getIssue(java.lang.Object issueIdOrKey)
        throws BacklogException

Returns the issue.

Parameters:

issueIdOrKey - the issue identifier

Returns:

the Issue

Throws:

BacklogException

updateIssue

Issue updateIssue(UpdateIssueParams params)
           throws BacklogException

Updates an existing issue.

Parameters:

params - the issue updating parameters

Returns:

the updated Issue

Throws:

BacklogException

deleteIssue

Issue deleteIssue(java.lang.Object issueIdOrKey)
           throws BacklogException

Deletes the issue.

Parameters:

issueIdOrKey - the issue identifier

Returns:

the deleted Issue

Throws:

BacklogException

getIssueComments

ResponseList<IssueComment> getIssueComments(java.lang.Object issueIdOrKey)
                                     throws BacklogException

Returns the issue comments.

Parameters:

issueIdOrKey - the issue identifier

Returns:

the issue's comments in a list.

Throws:

BacklogException

getIssueComments

ResponseList<IssueComment> getIssueComments(java.lang.Object issueIdOrKey,
                                            QueryParams queryParams)
                                     throws BacklogException

Returns the issue comments.

Parameters:

issueIdOrKey - the issue identifier

queryParams - the query parameters

Returns:

the issue's comments in a list.

Throws:

BacklogException

addIssueComment

IssueComment addIssueComment(AddIssueCommentParams params)
                      throws BacklogException

Adds a issue comment.

Parameters:

params - the issue comment adding parameters

Returns:

the added IssueComment

Throws:

BacklogException

getIssueCommentCount

int getIssueCommentCount(java.lang.Object issueIdOrKey)
                  throws BacklogException

Returns the count of the issue comments.

Parameters:

issueIdOrKey - the issue identifier

Returns:

count of the issue comments.

Throws:

BacklogException

getIssueComment

IssueComment getIssueComment(java.lang.Object issueIdOrKey,
                             java.lang.Object commentId)
                      throws BacklogException

Returns the issue comment.

Parameters:

issueIdOrKey - the issue identifier

commentId - the comment identifier

Returns:

the issue comment

Throws:

BacklogException

updateIssueComment

IssueComment updateIssueComment(UpdateIssueCommentParams params)
                         throws BacklogException

Updates an existing issue comment.

Parameters:

params - the issue comment updating parameters.

Returns:

the updated IssueComment

Throws:

BacklogException

getIssueCommentNotifications

ResponseList<Notification> getIssueCommentNotifications(java.lang.Object issueIdOrKey,
                                                        java.lang.Object commentId)
                                                 throws BacklogException

Returns the issue comment notifications.

Parameters:

issueIdOrKey - the issue identifier

commentId - the comment identifier

Returns:

the issue comment notifications

Throws:

BacklogException

addIssueCommentNotification

IssueComment addIssueCommentNotification(AddIssueCommentNotificationParams params)
                                  throws BacklogException

Adds a issue comment notification.

Parameters:

params - the issue comment notification adding parameters

Returns:

the issue comment

Throws:

BacklogException

getIssueAttachments

ResponseList<Attachment> getIssueAttachments(java.lang.Object issueIdOrKey)

Returns all the attachments on the issue.

Parameters:

issueIdOrKey - the issue identifier

Returns:

the attachments in a list.

downloadIssueAttachment

AttachmentData downloadIssueAttachment(java.lang.Object issueIdOrKey,
                                       java.lang.Object attachmentId)

Returns the attachment file data on the issue.

Parameters:

issueIdOrKey - the issue identifier

attachmentId - the attachment identifier

Returns:

the AttachmentData

deleteIssueAttachment

Attachment deleteIssueAttachment(java.lang.Object issueIdOrKey,
                                 java.lang.Object attachmentId)

Deletes the attachment file on the issue.

Parameters:

issueIdOrKey - the issue identifier

attachmentId - the attachment identifier

Returns:

the Attachment

getIssueSharedFiles

ResponseList<SharedFile> getIssueSharedFiles(java.lang.Object issueIdOrKey)

Returns all the shared files on the issue.

Parameters:

issueIdOrKey - the issue identifier

Returns:

the shared files in a list.

linkIssueSharedFile

ResponseList<SharedFile> linkIssueSharedFile(java.lang.Object issueIdOrKey,
                                             java.util.List fileIds)

links the shared files to the issue.

Parameters:

issueIdOrKey - the issue identifier

fileIds - the file identifiers in a list

Returns:

the linked shared files in a list.

unlinkIssueSharedFile

SharedFile unlinkIssueSharedFile(java.lang.Object issueIdOrKey,
                                 java.lang.Object fileId)

Deletes link of the shared file from the issue.

Parameters:

issueIdOrKey - the issue identifier

fileId - the file identifiers

Returns:

the unlinked SharedFile