Class icm.pgwidget.caselist.CaseList

Extends icm.base._BaseWidget, icm.base.BasePageWidget.
Represents the Case List widget which displays the cases that are returned by a search. Case workers can select a case to view from the list.
Defined in: <icm/pgwidget/caselist/test/CaseListWrapper.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.pgwidget.caselist.CaseList()

Method Summary

Method Attributes	Method Name and Description
	getDetailsViewModule() Returns the details view of the Case List widget.
	getMagazineViewModule() Returns the magazine view of the Case List widget.
	getViewModules() Returns the list of view modules that are displayed in the Case List widget.
	handleICM_ClearContentEvent() Handler for the icm.ClearContent event which can be used to clear the list of cases.
	handleICM_RefreshCaseListEvent() Handler for the icm.RefreshCaseList event which can be used to re-execute the query and refresh the list of cases.
	handleICM_SearchCasesEvent(payload) Handler for the icm.SearchCase event which is received when user starts a search for cases.
	handleICM_SelectRowEvent(payload) Handler for the icm.SelectRow event which can be used to select a case by row number or case id.
	handleICM_SortByProperty(payload) Handler for the icm.SortbyProperty event which can be used to sort the list of cases by the specified property of cases.

Method Detail

getDetailsViewModule()

Returns:

The details view of the Case List widget.

---

getMagazineViewModule()

Returns:

The magazine view of the Case List widget.

---

getViewModules()

Returns:

Returns an array of view modules that extends ecm.widget.listView._View.

---

handleICM_ClearContentEvent()

---

handleICM_RefreshCaseListEvent()

---

handleICM_SearchCasesEvent(payload)

Parameters:

payload

The event payload which contains the search criteria and case properties to be displayed.

---

handleICM_SelectRowEvent(payload)

Parameters:

payload

---

handleICM_SortByProperty(payload)

Parameters:

payload

---