Package com.atlassian.servicedesk.api.comment

Interface ServiceDeskCommentQuery

@PublicApi
public interface ServiceDeskCommentQuery

Parameters to query ServiceDeskComment

The following are examples to construct common queries:

     // Query both public and internal comments (default behavior)
     ServiceDeskCommentQuery query = commentService.newQueryBuilder().issue(issue).build();

     // Query public comments only
     ServiceDeskCommentQuery query = commentService.newQueryBuilder().issue(issue).publicComment(true).internalComment(false).build();

     // Query internal comments only
     ServiceDeskCommentQuery query = commentService.newQueryBuilder().issue(issue).publicComment(false).internalComment(true).build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ServiceDeskCommentQuery.Builder	Builder to construct the ServiceDeskCommentQuery.

Method Summary

Modifier and Type	Method	Description
boolean	internalComment()
com.atlassian.jira.issue.Issue	issue()
LimitedPagedRequest	pagedRequest()
boolean	publicComment()

Method Details

issue

com.atlassian.jira.issue.Issue issue()

Returns:

the Issue from which comments will be retrieved

pagedRequest

LimitedPagedRequest pagedRequest()

Returns:

which page of ServiceDeskComment to retrieve

publicComment

boolean publicComment()

Returns:

should include public comment or not, default to true

internalComment

boolean internalComment()

Returns:

should return internal comment or not, default to true