Package com.atlassian.jira.plugin.issuetabpanel

Class GetActionsRequest.Batching

java.lang.Object

com.atlassian.jira.plugin.issuetabpanel.GetActionsRequest.Batching

Enclosing class:

GetActionsRequest

@ExperimentalApi
public static class GetActionsRequest.Batching
extends Object

Limits and filters the actions returned from IssueTabPanel3.getActions(GetActionsRequest). By default to fetch a batch of actions we need following information:

• limit() - size of the batch, unless GetActionsRequest.isValidShowAllRequest() ()} is true
• fromDate() - date to search from, or null when searching from the oldest/newest
• fetchMode() - the direction of search

Since:

9.0

Constructor Summary

Constructors

Constructor	Description
Batching(GetActionsRequest.FetchMode fetchMode, Date fromDate, int limit)
Batching(GetActionsRequest.FetchMode fetchMode, Date fromDate, int limit, boolean returnOldest)

Method Summary

Modifier and Type	Method	Description
GetActionsRequest.FetchMode	fetchMode()	Controls which items shall we fetch.
Date	fromDate()
int	limit()	Used by tabs that limit the number of actions to show (e.g.
boolean	returnOldest()
static GetActionsRequest.Batching	searchFromNewest()
static GetActionsRequest.Batching	searchFromNewest(int limit)
static GetActionsRequest.Batching	searchFromOldest()
static GetActionsRequest.Batching	searchFromOldest(int limit)
static GetActionsRequest.Batching	searchNewerThanDate(Date date)
static GetActionsRequest.Batching	searchNewerThanDate(Date date, int limit)
static GetActionsRequest.Batching	searchOlderThanDate(Date date)
static GetActionsRequest.Batching	searchOlderThanDate(Date date, int limit)

Methods inherited from class java.lang.Object

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

Constructor Details

Batching

public Batching(@Nonnull
 GetActionsRequest.FetchMode fetchMode,
 @Nullable
 Date fromDate,
 int limit)

Batching

public Batching(@Nonnull
 GetActionsRequest.FetchMode fetchMode,
 @Nullable
 Date fromDate,
 int limit,
 boolean returnOldest)

Method Details

searchFromOldest

public static GetActionsRequest.Batching searchFromOldest()

searchFromOldest

public static GetActionsRequest.Batching searchFromOldest(int limit)

searchFromNewest

public static GetActionsRequest.Batching searchFromNewest()

searchFromNewest

public static GetActionsRequest.Batching searchFromNewest(int limit)

searchOlderThanDate

public static GetActionsRequest.Batching searchOlderThanDate(Date date)

searchOlderThanDate

public static GetActionsRequest.Batching searchOlderThanDate(Date date,
 int limit)

searchNewerThanDate

public static GetActionsRequest.Batching searchNewerThanDate(Date date)

searchNewerThanDate

public static GetActionsRequest.Batching searchNewerThanDate(Date date,
 int limit)

fetchMode

@Nonnull
public GetActionsRequest.FetchMode fetchMode()

Controls which items shall we fetch.

• GetActionsRequest.FetchMode.FROM_OLDEST - returned oldest actions ordered by date fromDate in oldest first order
• GetActionsRequest.FetchMode.FROM_NEWEST - returned newest actions ordered by date fromDate in oldest first order
• GetActionsRequest.FetchMode.OLDER_THAN_DATE - returned actions older than specified date ordered by date in oldest first order
• GetActionsRequest.FetchMode.NEWER_THAN_DATE - returned actions newer than specified date ordered by date in oldest first order

fromDate

@Nullable
public Date fromDate()

Returns:

Item date to start fetch from.

limit

public int limit()

Used by tabs that limit the number of actions to show (e.g. comments tab). If GetActionsRequest.isValidShowAllRequest() is true, this value must be ignored

Returns:

how many items should be retrieved at maximum or default when GetActionsRequest.isValidShowAllRequest() ()} returns true

returnOldest

public boolean returnOldest()

Returns:

flag indicating if the panels are supposed to return oldest entries (this is separate from sorting (fetchMode()