Class icm.pgwidget.contentlist.ContentList


Extends icm.base.BasePageWidget, icm.pgwidget.contentlist.dijit.ContentListContentPane.
Executes document search and displays results.
Defined in: <icm/pgwidget/contentlist/ContentList.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
icm.pgwidget.contentlist.ContentList()

Method Summary

Method Attributes Method Name and Description
 
handleICM_ClearContentEvent()
Handler of icm.ClearContent event.
 
handleICM_ReceiveDocumentIDsEvent(payload)
Display the list of documents that are referenced in the event payload.
 
handleICM_ReceiveSearchValuesEvent(payload)
Handler for icm.ReceivedSearchValues event.
 
handleICM_ReceiveStoredSearchEvent(payload)
Run the stored search that is specified in the payload and display the list of documents that are returned by the search.
 
handleICM_ReceiveWorkItemEvent(payload)
Handler for icm.ReceiveWorkItem event.
 
handleICM_RefreshContentEvent()
Handler for refresh event.

Constructor Detail

icm.pgwidget.contentlist.ContentList()

Method Detail

handleICM_ClearContentEvent()

Handler of icm.ClearContent event. Content List widget will clear widget UI content and display its description.

handleICM_ReceiveDocumentIDsEvent(payload)

Display the list of documents that are referenced in the event payload.
Parameters:
{object} payload
  • objectStoreNames: array of objstore symbolic names
  • symbolicNames: array of property symbolic names to be shown with results
  • values: array of dojo objs, each has obj.versionSeries field contains vsID
  • externalColumns: array of dojo objs, each has name and id of external columns
A sample payload is: 
				payload = {"objectStoreNames" : ["TOS"],
							"symbolicNames": [...],
							"values": [...],
						    "externalColumns": [{"symbolicName": "", "name": ""}]
				};

handleICM_ReceiveSearchValuesEvent(payload)

Handler for icm.ReceivedSearchValues event.
Parameters:
{Array} payload
A list of properties each with name and value pair to be used as criteria for the configured stored search.
A sample payload is: [{"AT_companyName": "IBM"}]

handleICM_ReceiveStoredSearchEvent(payload)

Run the stored search that is specified in the payload and display the list of documents that are returned by the search.
Parameters:
{object} payload
payload that contains the store search information.
  • StoredSearch.objectStoreName symbolic name of the object store that the search is stored.
  • StoredSearch.vsId version series ID of the stored search.
  • StoredSearch.version version status of the stored search.
A sample payload is: 
				payload = {
					"StoredSearch": {
						"objectStoreName": "TOS",
						"vsId": "753DFAA1-3EE5-4C44-89E3-51DEFFB7E371",
						"version": ""
					}
				};

handleICM_ReceiveWorkItemEvent(payload)

Handler for icm.ReceiveWorkItem event. Content List widget will use the workflow data field values that are specified in the event payload as the criteria for the configured stored search. Run the search and display the list of documents that is returned.
Parameters:
{object} payload
  • {object} workItemEditable: An icm.model.WorkItemEditable object that represents the work item for which a list of documents is to be returned.
A sample payload is: 
				payload = {"workItemEditable": workItemEditable};

handleICM_RefreshContentEvent()

Handler for refresh event. No payload are required for this event.