Class ecm.model.Message

Extends ecm.model._ModelObject.
Represents a message that is displayed to users in an error dialog box, a warning dialog box, or the status area.
Defined in: <ecm\model\Message.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.Message(properties) Constructor

Field Summary

Field Attributes	Field Name and Description
	adminResponse Instructions to the administrator on what can be done to attempt to resolve the situation (error messages only).
	backgroundRequest Boolean flag indicating if the message was created by a background request.
	explanation A detailed explanation to the user.
	level The level of the message: 0 = information, 1 = warning, 2 = error.
	messageProductId The message product ID that is prefixed to the messageNumber.
	moreInformation Additional information.
	number The message number.
	text The main message text.
	userResponse Instructions to the user on what can be done to attempt to resolve the situation (error messages only).

Fields borrowed from class ecm.model._ModelObject:: categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
<static>	ecm.model.Message.MessageFactory.createErrorMessage(messagePrefix, inserts, backgroundRequest, messages) Static function that creates an instance of ecm.model.Message for an error, given the message prefix for the error.

Methods borrowed from class ecm.model._ModelObject:: destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.Message(properties)

Constructor

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

Field Detail

adminResponse

Instructions to the administrator on what can be done to attempt to resolve the situation (error messages only).

backgroundRequest

Boolean flag indicating if the message was created by a background request.

explanation

A detailed explanation to the user.

level

The level of the message: 0 = information, 1 = warning, 2 = error.

messageProductId

The message product ID that is prefixed to the messageNumber.

moreInformation

Additional information.

number

The message number.

text

The main message text.

userResponse

Instructions to the user on what can be done to attempt to resolve the situation (error messages only).

Method Detail

<static> ecm.model.Message.MessageFactory.createErrorMessage(messagePrefix, inserts, backgroundRequest, messages)

Static function that creates an instance of ecm.model.Message for an error, given the message prefix for the error.

Parameters:
messagePrefix: The prefix of the set of strings related to the message as stored in the ecm.messages object.
inserts: An array of strings to insert into the message.
backgroundRequest: Boolean indicating if the message is being created by an background request.
messages: Optional messages to be used instead of ecm.messages.