Class icm.model.InbasketFilter


Extends ecm.model._ModelObject.
Represents a inbasket filter type
Defined in: <icm/model/InbasketFilter.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
Constructs a InbasketFilter object.

Field Summary

Field Attributes Field Name and Description
 
filter fields in dynamic filter.
 
true is hide Inbasket widget filter
 
true is hide work items locked by other.
 
inbasket name in dynamic filter.
 
Queue name in dynamic filter.

Method Summary

Method Attributes Method Name and Description
<static>  
icm.model.InbasketFilter.fromJSON(json)
A factory method to get a inbasket filter object from JSON object.

Constructor Detail

icm.model.InbasketFilter()

Constructs a InbasketFilter object.

Field Detail

filterFields

filter fields in dynamic filter.

hideFilterUI

true is hide Inbasket widget filter

hideLockedByOther

true is hide work items locked by other.

inbasketName

inbasket name in dynamic filter.

queueName

Queue name in dynamic filter.

Method Detail

<static> icm.model.InbasketFilter.fromJSON(json)

A factory method to get a inbasket filter object from JSON object.
Parameters:
json
Example input JSON:
	var json = {
		"queueName":"G603_R1",
		//inbasket queue name
		"inbasketName":"R1",
		//inbasket name
		"hideFilterUI":true,
		// true will hide the inbasket filter
		"filterFields": [
			{
 			"name":"1",
 			// filter name defined in PCC
				"value":11
				// filter value
			}
			{
 			"name":"2",
				"value":["abc","def"]
				// Array represents OR condition. The expression only supports equal operator.
				// When the filter operator is Equal, that mean "value==abc OR value==def"
			}
			{
 			"name":"3",
 			"value":["Red","Green"]
 			// If the filter field in PCC is a choice list type, value need to be input by choice item value.
			}
			{
 			"name":"4",
 			"value":["caseType1","caseType2"]
 			// If the filter field in PCC is case type, value need to be input by case type id
			}
		],
		"hideLockedByOther":true
		// true will hide the work items locked by other.
	};