cz.ues.platform.commons.lang

Class UESPagingCriteria

java.lang.Object

cz.ues.platform.commons.lang.UESPagingCriteria

Direct Known Subclasses:

AppBoxGetEntryList, AppGetEntryList, UESAccessRoleGetList, UESAccessRoleGetRoleInterfaceList, UESActivityActionGetActivityActionList, UESActivityConditionGetActivityConditionList, UESActivityGetActivityList, UESActivityGetInstanceList, UESActivityGetStateHistoryList, UESActivityStateTemplateGetActivityStateTemplateList, UESActivityTemplateGetActivityTemplateList, UESAllFromOrganizationalUnitCastGetCastList, UESArtifactGetReferenceList, UESArtifactSearchQuery, UESArtifactStateTemplateGetArtifactStateTemplateList, UESAttachmentGetAttachmentList, UESBasicPagingCriteria, UESCalendarGetBusyTimeList, UESCastGetAccessRoleCastList, UESCastGetCastList, UESCompanyGetEntryList, UESDigitalWorkspaceGetRecordList, UESEntityTypeGetChildrenList, UESFolderGetEntryList, UESFolderGetFolderEntryList, UESGroupGetRoleInterfaceList, UESLockGetList, UESMailGetEmailCapableRoleList, UESMetaAccessRoleGetRoleInterfaceList, UESMetaArtifactStateTemplateList, UESMetaGroupGetRoleInterfaceList, UESMetaModelGetEntryList, UESMetaPermissionGetAuthorityList, UESMetaPermissionGetMaskList, UESMetaPermissionGetSystemGroupList, UESMetaRoleGetRoleInterfaceList, UESObjectSchemaGetIndexList, UESObjectSchemaGetSchemaList, UESObjectStoreGetObjectList, UESObjectStoreGetStoreList, UESObjectStoreRepositoryGetRepositoryList, UESOrganizationalUnitGetEntryList, UESPermissionGetAuthorityList, UESPermissionGetMaskList, UESPermissionGetSystemGroupList, UESPersonalRoleGetTerritoryList, UESProcessGetProcessList, UESPropertyGetEntryList, UESPropertyGetPropertyList, UESPropertyTemplateGetEntryList, UESRoleGetArtifactList, UESRoleGetRoleInterfaceList, UESRoleInterfaceGetMetaArtifactList, UESRoleInterfaceGetRoleList, UESRoleSearchQuery, UESSheetGetSheetList, UESSheetGetVersionList, UESSheetTemplateGetSheetTemplateList, UESShortcutGetShortcutList, UESUseCaseFindUseCaseList, UseCaseGetUseCaseList, UseCaseRealizationGetUseCaseList, VisualUseCaseGetUseCaseList

@XMLBindable
public class UESPagingCriteria
extends java.lang.Object

The basic implementation that could be extended by DTOs used as UESCommand arguments. It is used to simplify realization of UESCommands.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private static int	MAX_PAGE_SIZE Maximum page size (defaults to ).
private int	pageIndex
private int	pageSize

Constructor Summary

Constructors

Constructor and Description
UESPagingCriteria() Creates a new instance of UESPagingCriteria.
UESPagingCriteria(int pageIndex, int pageSize) Creates a new instance of UESPagingCriteria with the given values.

Method Summary

Methods

Modifier and Type	Method and Description
int	getPageIndex() Returns index of the current page to be returned as result of the operation.
int	getPageSize() Returns count of objects to be returned as result of the operation.
void	setPageIndex(int pageIndex) Sets the current page index.
void	setPageSize(int pageSize) This method set the size of data-chunk retrieved for one call.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PAGE_SIZE

private static MAX_PAGE_SIZE

Maximum page size (defaults to ).

pageIndex

private pageIndex

pageSize

private pageSize

Constructor Detail

UESPagingCriteria

public UESPagingCriteria()

Creates a new instance of UESPagingCriteria.

Since:

UES6-00

UESPagingCriteria

public UESPagingCriteria(int pageIndex,
int pageSize)

Creates a new instance of UESPagingCriteria with the given values.

Parameters:

pageIndex - index of the result list page to obtain

pageSize - count of objects in the page

Since:

UES6-00

Method Detail

getPageIndex

public int getPageIndex()

Returns index of the current page to be returned as result of the operation. The value is always >=0.

Returns:

the current page index.

Since:

UES6-00

getPageSize

public int getPageSize()

Returns count of objects to be returned as result of the operation.

Returns:

current page size.

Since:

UES6-00

setPageIndex

public void setPageIndex(int pageIndex)

Sets the current page index.

Parameters:

pageIndex - Sets the index of page to be returned as result of UESCommand call. The page index should be from interval <0,PAGE_COUNT>, but no exception will be thrown when the index will be passed out of bounds - simply the minimal and maximal value will be used.

Since:

UES6-00

setPageSize

public void setPageSize(int pageSize)

This method set the size of data-chunk retrieved for one call. The change of this value may have impact on application performance, so please make changes very carefully. If you iterate over all items in result and the UESCommand is accessed through remote API, it may be useful to increase this value to avoid overhead of too many remote calls, but this may cause the high memory consumption on both - client and server side and large response size, that must be delivered through network. The server could limit the maximal page-size for a security reasons, please consult the maximum settings with your system provider. The page-size will be always set from interval <1,>, no exception will be thrown when value out of bounds will be passed as parameter.

Parameters:

pageSize - Sets the size of one page (sublist of data) retrieved for one UESCommand call.

Since:

UES6-00