Package com.atlassian.jira.plugin.issuetabpanel

Class GetActionsRequest

java.lang.Object

com.atlassian.jira.plugin.issuetabpanel.GetActionsRequest

@PublicApi
@Immutable
public final class GetActionsRequest
extends Object

Request object used in the IssueTabPanel2, IssueTabPanel3 and PaginatedIssueTabPanel SPI.

Since:

v5.0

See Also:

• IssueTabPanel2
• IssueTabPanel3
• PaginatedIssueTabPanel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetActionsRequest.Batching	Limits and filters the actions returned from IssueTabPanel3.getActions(GetActionsRequest).
static enum	GetActionsRequest.FetchMode
static interface	GetActionsRequest.GetActionRequestApplicationUser
static interface	GetActionsRequest.GetActionRequestAsync
static interface	GetActionsRequest.GetActionRequestBatch
static class	GetActionsRequest.GetActionRequestBuilder
static interface	GetActionsRequest.GetActionRequestCreator
static interface	GetActionsRequest.GetActionRequestIssue
static interface	GetActionsRequest.GetActionRequestShowAll

Field Summary

Fields

Modifier and Type	Field	Description
static final GetActionsRequest.Batching	DEFAULT_BATCHING
static final int	DEFAULT_INITIAL_LIMIT
static final int	DEFAULT_LIMIT
static final int	DEFAULT_LIMIT_FOR_FOCUSED_ITEM

Constructor Summary

Constructors

Constructor	Description
GetActionsRequest(Issue issue, ApplicationUser remoteUser, boolean asynchronous, boolean showAll, String focusId)
GetActionsRequest(Issue issue, ApplicationUser remoteUser, boolean asynchronous, boolean showAll, String focusId, GetActionsRequest.Batching batch)

Method Summary

Modifier and Type	Method	Description
GetActionsRequest.Batching	batching()	Information about requested batch of actions.
String	getFocusId()
boolean	isAnonymous()
boolean	isAsynchronous()
boolean	isShowAll()
Issue	issue()
boolean	isValidShowAllRequest()
ApplicationUser	loggedInUser()
ApplicationUser	remoteUser()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_INITIAL_LIMIT

public static final int DEFAULT_INITIAL_LIMIT

See Also:

• Constant Field Values

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

DEFAULT_LIMIT_FOR_FOCUSED_ITEM

public static final int DEFAULT_LIMIT_FOR_FOCUSED_ITEM

See Also:

• Constant Field Values

DEFAULT_BATCHING

@ExperimentalApi
public static final GetActionsRequest.Batching DEFAULT_BATCHING

Constructor Details

GetActionsRequest

@Internal
public GetActionsRequest(@Nonnull
 Issue issue,
 @Nullable
 ApplicationUser remoteUser,
 boolean asynchronous,
 boolean showAll,
 @Nullable
 String focusId)

GetActionsRequest

@Internal
public GetActionsRequest(@Nonnull
 Issue issue,
 @Nullable
 ApplicationUser remoteUser,
 boolean asynchronous,
 boolean showAll,
 @Nullable
 String focusId,
 @Nonnull
 GetActionsRequest.Batching batch)

Method Details

issue

@Nonnull
public Issue issue()

Returns:

the Issue on which the panel will be displayed

remoteUser

@Nullable
public ApplicationUser remoteUser()

Returns:

the User that is viewing the page, or null for an anonymous user

isAnonymous

public boolean isAnonymous()

Returns:

true iff the user that is viewing the page is anonymous (i.e. not logged in)

isAsynchronous

public boolean isAsynchronous()

Returns:

true if the actions are being loaded asynchronously, e.g. using an AJAX request

loggedInUser

@Nullable
public ApplicationUser loggedInUser()

isShowAll

public boolean isShowAll()

Returns:

true if all the actions should be returned

Used by tabs that limit the number of actions to show (e.g. comments tab)

getFocusId

@Nullable
public String getFocusId()

Returns:

id of the action that should be focused e.g. commentId for the comments tab

Used by tabs that limit the number of actions to show, so that the focused action can always be displayed

batching

@ExperimentalApi
@Nonnull
public GetActionsRequest.Batching batching()

Information about requested batch of actions.

Returns:

information about requested batch of actions.

isValidShowAllRequest

public boolean isValidShowAllRequest()