Index

A B C D E F G I L M N P R S T U V
All Classes|All Packages|Constant Field Values|Serialized Form

A

AbstractFilter<T extends ch.ivyteam.ivy.persistence.query.Query<?>> - Class in ch.ivy.addon.portalkit.filter

Base class for Filter

AbstractFilter() - Constructor for class ch.ivy.addon.portalkit.filter.AbstractFilter

AbstractFilterData<T extends AbstractFilter<?>> - Class in ch.ivy.addon.portalkit.filter

Data for filter

ALL - Static variable in class ch.ivy.addon.portalkit.filter.AbstractFilter

All options in filter are selected e.g all states

ApplicationMultiLanguageAPI - Class in ch.ivy.addon.portalkit.publicapi

Portal API for support multilingual menu

applyFilter(TaskFilterData) - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

Apply filter settings loaded from business data to this TaskLazyDataModel()

B

buildQuery() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilter

Build Query with filtered values.

C

CaseAPI - Class in ch.ivy.addon.portalkit.publicapi

Portal API for ICase

CaseExporter - Class in ch.ivy.addon.portalkit.exporter

Export Portal case list to Excel

CaseExporter(List<String>) - Constructor for class ch.ivy.addon.portalkit.exporter.CaseExporter

Constructor

CaseFilter - Class in ch.ivy.addon.portalkit.casefilter

Extend this class for custom case filter for example case name, case owner..

CaseFilter() - Constructor for class ch.ivy.addon.portalkit.casefilter.CaseFilter

CaseFilterContainer - Class in ch.ivy.addon.portalkit.casefilter

Extend this class for custom case filter container.

CaseFilterContainer() - Constructor for class ch.ivy.addon.portalkit.casefilter.CaseFilterContainer

Initialize list of filters here.

CaseLazyDataModel - Class in ch.ivy.addon.portalkit.datamodel

Lazy data model for case.

ch.ivy.addon.portalkit.casefilter - package ch.ivy.addon.portalkit.casefilter

This package contains abstract classes needed to extend to create custom case filter

ch.ivy.addon.portalkit.datamodel - package ch.ivy.addon.portalkit.datamodel

This package contains lazy data models.

ch.ivy.addon.portalkit.exporter - package ch.ivy.addon.portalkit.exporter

ch.ivy.addon.portalkit.filter - package ch.ivy.addon.portalkit.filter

This package contains abstract classes extended by task and case filter

ch.ivy.addon.portalkit.publicapi - package ch.ivy.addon.portalkit.publicapi

This package contains all public APIs of Portal.

ch.ivy.addon.portalkit.taskfilter - package ch.ivy.addon.portalkit.taskfilter

This package contains abstract classes needed to extend to create custom task filter

com.axonivy.portal.components.dto - package com.axonivy.portal.components.dto

D

DashboardCaseLazyDataModel - Class in ch.ivy.addon.portalkit.datamodel

DashboardCaseLazyDataModel() - Constructor for class ch.ivy.addon.portalkit.datamodel.DashboardCaseLazyDataModel

DashboardProcessCaseLazyDataModel - Class in ch.ivy.addon.portalkit.datamodel

DashboardProcessCaseLazyDataModel(Long, String) - Constructor for class ch.ivy.addon.portalkit.datamodel.DashboardProcessCaseLazyDataModel

DashboardProcessTaskLazyDataModel - Class in ch.ivy.addon.portalkit.datamodel

DashboardProcessTaskLazyDataModel(Long, String) - Constructor for class ch.ivy.addon.portalkit.datamodel.DashboardProcessTaskLazyDataModel

DashboardTaskLazyDataModel - Class in ch.ivy.addon.portalkit.datamodel

DashboardTaskLazyDataModel() - Constructor for class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

defaultFilter() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilter

Check filter category show default in Task/Case List

displayCustomizedMessage(String) - Method in class ch.ivy.addon.portalkit.publicapi.PortalGlobalGrowInIFrameAPI

Displays Portal Growl customized message.

E

Exporter - Class in ch.ivy.addon.portalkit.exporter

Base class for export Provide function to get stream content, default header ..

Exporter() - Constructor for class ch.ivy.addon.portalkit.exporter.Exporter

Exporter(List<String>) - Constructor for class ch.ivy.addon.portalkit.exporter.Exporter

extendSort(CaseQuery) - Method in class ch.ivy.addon.portalkit.datamodel.CaseLazyDataModel

If your customized case list has new columns/fields, please extend the caseQuery parameter with the sort query for these fields.

extendSort(TaskQuery) - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

If your customized task list has new columns/fields, please extend the taskQuery parameter with the sort query for these fields.

F

findRelativeUrlByProcessStartFriendlyRequestPath(String) - Static method in class ch.ivy.addon.portalkit.publicapi.ProcessStartAPI

Find start link from friendly request path

findStartableLinkByUserFriendlyRequestPath(String) - Static method in class ch.ivy.addon.portalkit.publicapi.ProcessStartAPI

Find startable link from friendly request path

G

getBriefDisplayNameWithState() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

getBriefDisplayNameWithState() - Method in class com.axonivy.portal.components.dto.UserDTO

getCanWorkOn() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

getCmsValueByUserLocale(String) - Static method in class ch.ivy.addon.portalkit.publicapi.ApplicationMultiLanguageAPI

Get CMS value for specific URI based on current locale

getColumnLabel(String) - Method in class ch.ivy.addon.portalkit.datamodel.CaseLazyDataModel

In case you adds new columns, these columns need cms to show in config columns panel

getColumnLabel(String) - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

In case you adds new columns, these columns need cms to show in config columns panel

getColumnName(String) - Method in class ch.ivy.addon.portalkit.exporter.CaseExporter

Gets column label.

getColumnName(String) - Method in class ch.ivy.addon.portalkit.exporter.Exporter

Get display column label based on session language

getColumnName(String) - Method in class ch.ivy.addon.portalkit.exporter.TaskExporter

Gets column label.

getColumnValue(String, ICase) - Method in class ch.ivy.addon.portalkit.exporter.CaseExporter

Gets case column value.

getColumnValue(String, ITask) - Method in class ch.ivy.addon.portalkit.exporter.TaskExporter

Gets task column value.

getCriteria() - Method in class ch.ivy.addon.portalkit.datamodel.CaseLazyDataModel

Getter for case search criteria

getCriteria() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardCaseLazyDataModel

getCriteria() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessCaseLazyDataModel

getCriteria() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessTaskLazyDataModel

getCriteria() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

getCriteria() - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

Getter for task search criteria

getDefaultColumns() - Method in class ch.ivy.addon.portalkit.datamodel.CaseLazyDataModel

Your customized data model needs to override this method if your customized case list has new columns/fields.

getDefaultColumns() - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

Your customized data model needs to override this method if your customized task list has new columns/fields.

getDisplayName() - Method in class com.axonivy.portal.components.dto.RoleDTO

getDisplayName() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

getDisplayName() - Method in class com.axonivy.portal.components.dto.UserDTO

getEmail() - Method in class com.axonivy.portal.components.dto.UserDTO

getEMailAddress() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

getErrorMessage() - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

getFilterGroupId() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Getter of group id.

getFilterName() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Getter for name

getFilters() - Method in class ch.ivy.addon.portalkit.casefilter.CaseFilterContainer

Getter of all filters

getFilters() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Getter for filter list

getFilters() - Method in class ch.ivy.addon.portalkit.taskfilter.TaskFilterContainer

Getter for all filters

getId() - Method in class com.axonivy.portal.components.dto.RoleDTO

getId() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

getId() - Method in class com.axonivy.portal.components.dto.UserDTO

getKeyword() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Getter for keyword

getMemberName() - Method in class com.axonivy.portal.components.dto.RoleDTO

getMemberName() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

getMemberName() - Method in class com.axonivy.portal.components.dto.UserDTO

getName() - Method in class com.axonivy.portal.components.dto.RoleDTO

getName() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

getName() - Method in class com.axonivy.portal.components.dto.UserDTO

getPortalTaskSort() - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

This is default of sort item, override it if you want to customize it IMPORTANT: Item in this list must follow pattern : column name + "_ASC" or column name + "_DESC" E.g your customize portal column are Arrays.asList{"PRIORITY", "NAME", "ID" , "ACTIVATOR", "CREATION_TIME", "EXPIRY_TIME", "CustomerName", "CustomerType"} You can have sort fields like: return Arrays.asList("CREATION_TIME_ASC", "CREATION_TIME_DESC", "CustomerName_ASC", "CustomerName_DESC", "CustomerType_ASC", "CustomerType_DESC"}

getProcesses() - Method in class com.axonivy.portal.components.dto.IvyProcessResultDTO

getRowData(String) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardCaseLazyDataModel

getRowData(String) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessCaseLazyDataModel

getRowData(String) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessTaskLazyDataModel

getRowData(String) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

getRowKey(ICase) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardCaseLazyDataModel

getRowKey(ICase) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessCaseLazyDataModel

getRowKey(ITask) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessTaskLazyDataModel

getRowKey(ITask) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

getSelectedCompactSort() - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

getSortFieldLabel(String) - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

Sort field label.

getStateFilter() - Method in class ch.ivy.addon.portalkit.casefilter.CaseFilterContainer

Getter for default case state filter

getStateFilter() - Method in class ch.ivy.addon.portalkit.taskfilter.TaskFilterContainer

Getter for default task state filter

getStreamedContent(List<T>) - Method in class ch.ivy.addon.portalkit.exporter.Exporter

Create stream content StreamedContent to export

getType() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Getter for type

getUserId() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Getter for user Id

getWebLink() - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

getWebStartable() - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

I

initFilterContainer() - Method in class ch.ivy.addon.portalkit.datamodel.CaseLazyDataModel

Initialize CaseFilterContainer with your customized CaseFilterContainer class.

initFilterContainer() - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

Initialize TaskFilterContainer with your customized TaskFilterContainer class.

initUserProcessByExpressProcessName(String, String) - Static method in class ch.ivy.addon.portalkit.publicapi.ProcessStartAPI

Initiates UserProcess by ExpressProcess name.

initUserProcessByExternalLinkName(String, String) - Static method in class ch.ivy.addon.portalkit.publicapi.ProcessStartAPI

Initiates UserProcess by External Link name.

initUserProcessByUserFriendlyRequestPath(String, String) - Static method in class ch.ivy.addon.portalkit.publicapi.ProcessStartAPI

Initiates UserProcess by user friendly request path.

isEnabled() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

isEnabled() - Method in class com.axonivy.portal.components.dto.UserDTO

isError() - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

isSelectedColumn(String) - Method in class ch.ivy.addon.portalkit.datamodel.CaseLazyDataModel

Check if your column is selected

isSelectedColumn(String) - Method in class ch.ivy.addon.portalkit.datamodel.TaskLazyDataModel

Check if your column is selected

isUser() - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

IvyProcessResultDTO - Class in com.axonivy.portal.components.dto

IvyProcessResultDTO() - Constructor for class com.axonivy.portal.components.dto.IvyProcessResultDTO

IvyProcessResultDTO(List<IWebStartable>) - Constructor for class com.axonivy.portal.components.dto.IvyProcessResultDTO

L

label() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilter

The string label is displayed in filter item and checkbox filter item.

load(int, int, String, SortOrder, Map<String, Object>) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardCaseLazyDataModel

load(int, int, String, SortOrder, Map<String, Object>) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessCaseLazyDataModel

load(int, int, String, SortOrder, Map<String, Object>) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessTaskLazyDataModel

load(int, int, String, SortOrder, Map<String, Object>) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

loadFirstTime() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardCaseLazyDataModel

loadFirstTime() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessCaseLazyDataModel

loadFirstTime() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessTaskLazyDataModel

loadFirstTime() - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

M

MAX_ROW_NUMBER_IN_EXCEL - Static variable in class ch.ivy.addon.portalkit.exporter.Exporter

Excel limit row number

N

navigateToPortalEndPage() - Static method in class ch.ivy.addon.portalkit.publicapi.PortalNavigatorAPI

Navigate to PortalEndPage without finishing a task, e.g.

navigateToPortalHome() - Static method in class ch.ivy.addon.portalkit.publicapi.PortalNavigatorAPI

Navigate to Portal home

P

PortalGlobalGrowInIFrameAPI - Class in ch.ivy.addon.portalkit.publicapi

PortalGlobalGrowInIFrameAPI() - Constructor for class ch.ivy.addon.portalkit.publicapi.PortalGlobalGrowInIFrameAPI

PortalNavigatorAPI - Class in ch.ivy.addon.portalkit.publicapi

Portal API for navigation not in iFrame

ProcessStartAPI - Class in ch.ivy.addon.portalkit.publicapi

Portal API for process start

ProcessViewerDTO - Class in com.axonivy.portal.components.dto

ProcessViewerDTO() - Constructor for class com.axonivy.portal.components.dto.ProcessViewerDTO

ProcessViewerDTO(IWebStartable, WebLink, boolean, String) - Constructor for class com.axonivy.portal.components.dto.ProcessViewerDTO

R

reloadView() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilter

Override this method if need to reload data list (such as case list, task list) after add/remove new filter

removeHidePropertyToDisplayInPortal(ICase) - Static method in class ch.ivy.addon.portalkit.publicapi.CaseAPI

Remove the "HIDE" additional property to the given case to display it in case list of Portal.

removeHidePropertyToDisplayInPortal(ITask) - Static method in class ch.ivy.addon.portalkit.publicapi.TaskAPI

Remove the "HIDE" additional property to the given task to display it in task list of Portal.

removeProperty(IRole, String) - Static method in class ch.ivy.addon.portalkit.publicapi.RoleAPI

Remove property for passed role

resetValues() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilter

Set filtered variables to new values (mostly empty) after close/deselect filter item on UI.

RoleAPI - Class in ch.ivy.addon.portalkit.publicapi

Portal API for IRole

RoleDTO - Class in com.axonivy.portal.components.dto

RoleDTO() - Constructor for class com.axonivy.portal.components.dto.RoleDTO

RoleDTO(IRole) - Constructor for class com.axonivy.portal.components.dto.RoleDTO

S

search() - Method in class ch.ivy.addon.portalkit.datamodel.SearchResultsDataModel

Implement your custom search function by override this function

SearchResultsDataModel - Class in ch.ivy.addon.portalkit.datamodel

Lazy data model for search.

SecurityMemberDTO - Class in com.axonivy.portal.components.dto

SecurityMemberDTO() - Constructor for class com.axonivy.portal.components.dto.SecurityMemberDTO

SecurityMemberDTO(ISecurityMember) - Constructor for class com.axonivy.portal.components.dto.SecurityMemberDTO

setCanWorkOn(boolean) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

setCriteria(DashboardCaseSearchCriteria) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardCaseLazyDataModel

setCriteria(DashboardProcessCaseSearchCriteria) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessCaseLazyDataModel

setCriteria(DashboardProcessTaskSearchCriteria) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardProcessTaskLazyDataModel

setCriteria(DashboardTaskSearchCriteria) - Method in class ch.ivy.addon.portalkit.datamodel.DashboardTaskLazyDataModel

setDisplayName(String) - Method in class com.axonivy.portal.components.dto.RoleDTO

setDisplayName(String) - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

setDisplayName(String) - Method in class com.axonivy.portal.components.dto.UserDTO

setEmail(String) - Method in class com.axonivy.portal.components.dto.UserDTO

setEMailAddress(String) - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

setEnabled(boolean) - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

setEnabled(boolean) - Method in class com.axonivy.portal.components.dto.UserDTO

setError(boolean) - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

setErrorMessage(String) - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

setFilterGroupId(Long) - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Setter of group id.

setFilterName(String) - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Setter for name

setFilters(List<CaseFilter>) - Method in class ch.ivy.addon.portalkit.casefilter.CaseFilterContainer

Setter of all filters

setFilters(List<TaskFilter>) - Method in class ch.ivy.addon.portalkit.taskfilter.TaskFilterContainer

Setter for all filters

setFilters(List<T>) - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Setter for filter list

setHidePropertyToHideInPortal(ICase) - Static method in class ch.ivy.addon.portalkit.publicapi.CaseAPI

Set the "HIDE" additional property to the given case to hide it in case list of Portal.

setHidePropertyToHideInPortal(ITask) - Static method in class ch.ivy.addon.portalkit.publicapi.TaskAPI

Set the "HIDE" additional property to the given task to hide it in task list of Portal.

setId(long) - Method in class com.axonivy.portal.components.dto.RoleDTO

setId(long) - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

setId(long) - Method in class com.axonivy.portal.components.dto.UserDTO

setKeyword(String) - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Setter for keyword

setMemberName(String) - Method in class com.axonivy.portal.components.dto.RoleDTO

setMemberName(String) - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

setMemberName(String) - Method in class com.axonivy.portal.components.dto.UserDTO

setName(String) - Method in class com.axonivy.portal.components.dto.RoleDTO

setName(String) - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

setName(String) - Method in class com.axonivy.portal.components.dto.UserDTO

setProcesses(List<IWebStartable>) - Method in class com.axonivy.portal.components.dto.IvyProcessResultDTO

setProperty(IRole, String, String) - Static method in class ch.ivy.addon.portalkit.publicapi.RoleAPI

Set property for passed role

setStateFilter(CaseStateFilter) - Method in class ch.ivy.addon.portalkit.casefilter.CaseFilterContainer

Setter of default case state filter

setStateFilter(TaskStateFilter) - Method in class ch.ivy.addon.portalkit.taskfilter.TaskFilterContainer

Setter for default task state filter

setType(FilterType) - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Setter for type

setUser(boolean) - Method in class com.axonivy.portal.components.dto.SecurityMemberDTO

setUserId(Long) - Method in class ch.ivy.addon.portalkit.filter.AbstractFilterData

Setter for user Id

setWebLink(WebLink) - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

setWebStartable(IWebStartable) - Method in class com.axonivy.portal.components.dto.ProcessViewerDTO

T

TaskAPI - Class in ch.ivy.addon.portalkit.publicapi

Portal API for ITask

TaskExporter - Class in ch.ivy.addon.portalkit.exporter

Export Portal task list to Excel

TaskExporter(List<String>) - Constructor for class ch.ivy.addon.portalkit.exporter.TaskExporter

TaskFilter - Class in ch.ivy.addon.portalkit.taskfilter

Extend this class for custom task filter for example task name, task state..

TaskFilter() - Constructor for class ch.ivy.addon.portalkit.taskfilter.TaskFilter

TaskFilterContainer - Class in ch.ivy.addon.portalkit.taskfilter

Extend this class for custom task filter container.

TaskFilterContainer() - Constructor for class ch.ivy.addon.portalkit.taskfilter.TaskFilterContainer

Initialize list of filters here.

TaskLazyDataModel - Class in ch.ivy.addon.portalkit.datamodel

Lazy data model for task.

U

UserDTO - Class in com.axonivy.portal.components.dto

UserDTO() - Constructor for class com.axonivy.portal.components.dto.UserDTO

UserDTO(Record) - Constructor for class com.axonivy.portal.components.dto.UserDTO

UserDTO(IUser) - Constructor for class com.axonivy.portal.components.dto.UserDTO

UserDTO(UserDTO) - Constructor for class com.axonivy.portal.components.dto.UserDTO

V

validate() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilter

Override this method if need to validate filtered values.

value() - Method in class ch.ivy.addon.portalkit.filter.AbstractFilter

The string value is displayed in filter item.

A B C D E F G I L M N P R S T U V
All Classes|All Packages|Constant Field Values|Serialized Form