Class icm.model.CaseType

Extends ecm.model.ContentClass.
Represents a case type.
Defined in: <icm/model/CaseType.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.model.CaseType(properties) Constructs a CaseType object.

Field Summary

Field Attributes	Field Name and Description
	annotationCreationRights Indicates whether the current user has permission to create annotations on cases of this type.
	caseClassId The GUID of the case class.
	caseTitleProperty The symbolic name of the property used for the case title.
	caseTypeFolderId The Id of the case type folder
	copyExternalDocumentTitleAllowed Indicates whether copy external documents title is allowed for this case type.
	createSubfolderRights Indicates whether the current user has permission to create sub-folders on cases of this type.
	defaultViewDefinition The default view reference name for this case type.
	description The textual description of this case type
	discretionaryTaskTypes The discretionary task types.
	discretionaryTaskTypesById The discretionary task types keyed by id.
	dynamicTaskAllowed Indicates whether dynamic tasks are allowed for this case type.
	dynamicTaskCreationRights Indicates whether the current user has permission to create dynamic tasks.
	externalDataSupported Indicates if this case type supports integration with an external data service.
	externalDocumentsAllowed Indicates whether external documents are allowed for this case type.
	instanceCreationRights Indicates whether the current user has permission to create cases of this type.
	searchView The search view
	solution The solution this case type belongs to
	summaryView The summary view

Method Summary

Method Attributes	Method Name and Description
	getViewDefinitionResourceBundle() Returns the URI for the resource bundle that contains the view definitions.
	getViewDefinitionUri(viewDefinitionId) Returns the URI for the specified view definition.
	retrieveAttributeDefinitions(callback, errCallback, backgroundRequest) Retrieves the attribute definitions for this case type.
	retrieveDiscretionaryTaskTypes(callback, errCallback, backgroundRequest) Retrieves the discretionary task types in the case type.
	retrievePage(pageType, role, callback, errCallback, backgroundRequest) Retrieves the page appropriate for a particular type and optional role.
	searchDynamicTasks(searchCriteria, andSearch, resultsDisplay, callback, errorCallback, backgroundRequest) Executes a query for dynamic tasks

Constructor Detail

icm.model.CaseType(properties)

Constructs a CaseType object. A CaseType object is typically constructed internally by other model objects.

Parameters:
properties: The properties for the CaseType object. The properties can be any of the public fields as defined below and on ecm.model.ContentClass.

Field Detail

annotationCreationRights

Indicates whether the current user has permission to create annotations on cases of this type.

caseClassId

The GUID of the case class.

caseTitleProperty

The symbolic name of the property used for the case title.

caseTypeFolderId

The Id of the case type folder

copyExternalDocumentTitleAllowed

Indicates whether copy external documents title is allowed for this case type.

createSubfolderRights

Indicates whether the current user has permission to create sub-folders on cases of this type.

defaultViewDefinition

The default view reference name for this case type. This is an empty string if no default view is defined for this case type

description

The textual description of this case type

discretionaryTaskTypes

The discretionary task types.

discretionaryTaskTypesById

The discretionary task types keyed by id.

dynamicTaskAllowed

Indicates whether dynamic tasks are allowed for this case type.

dynamicTaskCreationRights

Indicates whether the current user has permission to create dynamic tasks.

externalDataSupported

Indicates if this case type supports integration with an external data service.

externalDocumentsAllowed

Indicates whether external documents are allowed for this case type.

instanceCreationRights

Indicates whether the current user has permission to create cases of this type.

searchView

The search view

solution

The solution this case type belongs to

summaryView

The summary view

Method Detail

getViewDefinitionResourceBundle()

Returns the URI for the resource bundle that contains the view definitions.

getViewDefinitionUri(viewDefinitionId)

Returns the URI for the specified view definition.

Parameters:
viewDefinitionId: the symbolic name for the view definition

retrieveAttributeDefinitions(callback, errCallback, backgroundRequest)

Retrieves the attribute definitions for this case type. The attribute definitions are appropriate when dealing with generic attributes for a case type, such as when building search criteria. When editing an existing case instance or creating a new case instance, the attribute definitions can still be unique for that instance (such as when dependent attributes are involved), so the attribute definitions should always be obtained from the Case or CaseEditable object.

Parameters:
callback: a function called with an array of ecm.model.AttributeDefinition objects
errCallback: An optional argument. A function called if the request fails.
backgroundRequest: An optional argument. If true, indicates the request is processed in the background.

retrieveDiscretionaryTaskTypes(callback, errCallback, backgroundRequest)

Retrieves the discretionary task types in the case type.

Parameters:
callback: a function called with an array of icm.model.TaskType objects
errCallback: An optional argument. A function called if the request fails.
backgroundRequest: An optional argument. If true, indicates the request is processed in the background.

retrievePage(pageType, role, callback, errCallback, backgroundRequest)

Retrieves the page appropriate for a particular type and optional role.

Parameters:
pageType: the page type. Valid types are CasePage, CaseCreationPage, CaseSplitPage, and DynamicTaskStepPage.
role: the role name or ecm.model.ProcessRole object
callback: a function that is called when retrieval is complete. See icm.model.Solution.retrieveStaticPages for the page information returned.
errCallback: An optional argument. A function called if the request fails.
backgroundRequest: An optional argument. If true, indicates the request is processed in the background.

searchDynamicTasks(searchCriteria, andSearch, resultsDisplay, callback, errorCallback, backgroundRequest)

Executes a query for dynamic tasks

Parameters:

searchCriteria

An array of ecm.model.SearchCriterion objects that define the search criteria. For example, the criteria of tasks created by a particular user for a Case object is:

var criteria = [
        new ecm.model.SearchCriterion({
                name: "Creator",
                defaultValue: "ICMUser",
                defaultOperator: "EQUAL",
                dataType: "xs:string"
            }),
        new ecm.model.SearchCriterion({
                name: "Coordinator",
                defaultValue: caseId,
                defaultOperator: "EQUAL",
                dataType: "xs:object"
            })];

andSearch

True if the criteria are anded together, otherwise they are orred.

resultsDisplay

A javascript object that defined the display attributes of the returned results. For example:

         {sortBy: "DateCreated", sortAsc: false}

callback

A function called with an icm.model.ResultSet object when the request completes.

errorCallback

An optional argument that, if specified, is a function called if there is an error in the request.

backgroundRequest

An optional argument that specifies if the request should be processed in the background.