Class icm.pgwidget.todolist.ToDoList

Class that represents the To-Do list Widget
Defined in: <icm/pgwidget/todolist/ToDoList.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.pgwidget.todolist.ToDoList()

Field Summary

Field Attributes	Field Name and Description
	payload The payload data from the event being handled

Method Summary

Method Attributes	Method Name and Description
	destroy() destroy the objects for releasing memory.
	getCfgOfTaskTypeList(caseType) get the configuration about which to-do task type should be listed and the order shown by default.
	handleICM_ClearContentEvent() Clean the content.
	handleICM_RefreshToDoTaskListEvent(payload) Handler for the icm.RefreshToDoTaskList event to refresh to do list.
	handleICM_SelectCaseEvent(payload) Handler for the icm.SelectCase event when selecting a case on case page.
	handleICM_SendCaseInfoEvent(payload) Handler for the icm.SendCaseInfo event.
	handleICM_SendWorkItemEvent(payload) Handler for the icm.SendWorkItem event.
	handleICM_ToDoTaskAddedEvent(payload) Handler for the icm.ToDoTaskAdded event.
	parseCustomizedPayload(payload) parse the customized settings from payload data of the event being handled and set them.
	postCreate() set the dijit class configuration for handling to-do task types
	renderToDoList() Render the to-do list for current case based on the customized settings.

Constructor Detail

icm.pgwidget.todolist.ToDoList()

Field Detail

payload

The payload data from the event being handled

Method Detail

destroy()

destroy the objects for releasing memory.

getCfgOfTaskTypeList(caseType)

get the configuration about which to-do task type should be listed and the order shown by default.

Parameters:
caseType: A string represents the case type of current case.

Returns:: An array object including which to-do task type belonging to the case type should be listed. The order of elements in the array is the order shown by default.

handleICM_ClearContentEvent()

Clean the content.

handleICM_RefreshToDoTaskListEvent(payload)

Handler for the icm.RefreshToDoTaskList event to refresh to do list. The payload is optional.

Parameters:

payload

- optional

caseEditable: An icm.model.CaseEditable object that represents the case that is to be displayed.
coordination: An icm.util.Coordination object that is used internally by the widgets in the same page.

           Example: payload = { "caseEditable": caseEditable,
           "coordination": new icm.util.Coordination() };

handleICM_SelectCaseEvent(payload)

Handler for the icm.SelectCase event when selecting a case on case page. Display the case information for the case that is contained in the event payload.

Parameters:

payload

caseEditable: An icm.model.CaseEditable object that represents the case that is to be displayed.

           Example: payload = { "caseEditable": caseEditable};

handleICM_SendCaseInfoEvent(payload)

Handler for the icm.SendCaseInfo event. Properties widget will display the case properties in the widget UI.

Parameters:

payload

caseEditable: An icm.model.CaseEditable object that represents the case that is to be displayed.
coordination: An icm.util.Coordination object that is used internally by the widgets in the same page.

 	Example: payload = {
			"caseEditable": caseEditable,
			"coordination": coordination
		};

handleICM_SendWorkItemEvent(payload)

Handler for the icm.SendWorkItem event.

Parameters:

payload

workItemEditable: An icm.model.CaseEditable object that represents the workitem that is to be displayed.
coordination: An icm.util.Coordination object that is used internally by the widgets in the same page.

 Example: payload = {
				"workItemEditable": workItemEditable,
				"coordination": coordination
			};

handleICM_ToDoTaskAddedEvent(payload)

Handler for the icm.ToDoTaskAdded event. To-Do list page widget will display the to-do item added in the widget UI.

Parameters:

payload

ToDoTaskEditable: An icm.model.TaskEditable object that represents the to-do item that is to be added.

 	Example: payload = {
			"ToDoTaskEditable": ToDoTaskEditable
		};

parseCustomizedPayload(payload)

parse the customized settings from payload data of the event being handled and set them.

propertyList: An array object that represents which task properties should be returned on calling search to-do task API.
propertyFilter: A string object representing the conditions on calling search to-do task API.
gridStructure: A JS object which is used as the structure of grid to show to-do list.
resultDisplay: An optional javascript object that defines the display attributes of the returned results.
includeHidden: Pass true to include hidden tasks in the results. Otherwise hidden tasks will be filtered out.

Parameters:
payload

postCreate()

set the dijit class configuration for handling to-do task types

renderToDoList()

Render the to-do list for current case based on the customized settings.