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 SPI.

Since:

v5.0

See Also:

IssueTabPanel2

Constructor Summary

Constructors

Constructor and Description
GetActionsRequest(Issue issue, com.atlassian.crowd.embedded.api.User remoteUser, boolean asynchronous, boolean showAll, String focusId)

Method Summary

Methods

Modifier and Type	Method and Description
String	getFocusId()
boolean	isAnonymous()
boolean	isAsynchronous()
boolean	isShowAll()
Issue	issue()
ApplicationUser	loggedInUser()
com.atlassian.crowd.embedded.api.User	remoteUser()

Methods inherited from class java.lang.Object

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

Constructor Detail

GetActionsRequest

@Internal
public GetActionsRequest(@Nonnull
                          Issue issue,
                          @Nullable
                          com.atlassian.crowd.embedded.api.User remoteUser,
                          boolean asynchronous,
                          boolean showAll,
                          @Nullable
                          String focusId)

Method Detail

issue

@Nonnull
public Issue issue()

Returns:

the Issue on which the panel will be displayed

remoteUser

@Nullable
public com.atlassian.crowd.embedded.api.User 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

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

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