Package io.jmix.reports

Class ReportLoadContext

java.lang.Object

io.jmix.reports.ReportLoadContext

public final class ReportLoadContext
extends Object

Filtering, pagination and sorting options when loading reports from ReportRepository.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROUP_SORT_KEY	Custom sort keys.
static final String	LOCALIZED_NAME_SORT_KEY

Constructor Summary

Constructors

Constructor	Description
ReportLoadContext(ReportFilter filter)	Create context to load report list.
ReportLoadContext(ReportFilter filter, Sort sort)	Create context to load report list.
ReportLoadContext(ReportFilter filter, Sort sort, int firstResult, int maxResults)	Create context to load report list.

Method Summary

Modifier and Type	Method	Description
ReportFilter	getFilter()
int	getFirstResult()
int	getMaxResults()
Sort	getSort()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

GROUP_SORT_KEY

public static final String GROUP_SORT_KEY

Custom sort keys.

See Also:

• Constant Field Values

LOCALIZED_NAME_SORT_KEY

public static final String LOCALIZED_NAME_SORT_KEY

See Also:

• Constant Field Values

Constructor Details

ReportLoadContext

public ReportLoadContext(ReportFilter filter,
 @Nullable
 Sort sort,
 int firstResult,
 int maxResults)

Create context to load report list.

Parameters:

filter - filter values

sort - sort clauses, whose properties must refer to property names of Report or be one of above-mentioned custom sort keys

firstResult - number of items to skip if needed

maxResults - maximum items to load, if 0 then unlimited

ReportLoadContext

public ReportLoadContext(ReportFilter filter,
 Sort sort)

Create context to load report list.

Parameters:

filter - filter values

sort - sort clauses, whose properties must refer to property names of Report or be one of above-mentioned custom sort keys

ReportLoadContext

public ReportLoadContext(ReportFilter filter)

Create context to load report list.

Parameters:

filter - filter values

Method Details

toString

public String toString()

Overrides:

toString in class Object

getFilter

public ReportFilter getFilter()

getSort

@Nullable
public Sort getSort()

getFirstResult

public int getFirstResult()

getMaxResults

public int getMaxResults()