Function Namespace kocujILV12aCBackendMessage

kocujILV12aCBackendMessage
Defined in: message.js.

Function Namespace Summary
Constructor Attributes	Constructor Name and Description
	kocujILV12aCBackendMessage() Message prototype constructor

Field Summary
Field Attributes	Field Name and Description
<private>	_objAllJsAjax Object kocujILV12aAllJsAjax
<private>	_objHelper Object kocujILV12aHelper
<private>	_prj Projects list
<private>	_thisFilename Current script filename
<private>	_valsPrefix Script settings - prefix
<private>	_valsSecurity Script settings - security string
<private>	_valsThrowErrors Script settings - throw errors (true) or not (false)

Method Summary
Method Attributes	Method Name and Description
<private>	_checkAddProject(projectId) Check arguments for adding project
<private>	_getHTMLNameMessage(projectId, messageId) Get HTML prefix for message
<private>	_getHTMLPrefix(projectId) Get HTML prefix
<private>	_parseProjectId(projectId) Parse project identifier
<private>	_throwError(codeString, param) Throw an error if debugging is enabled
	addMessageCloseButton(projectId, messageId) Add close button for message
	addProject(projectId) Add project
	addProjectIfNotExists(projectId) Add project if not exists
	getHTMLSelectorMessage(projectId, messageId) Get HTML selector for message

Function Namespace Detail

kocujILV12aCBackendMessage()

Message prototype constructor

Returns:: {void}

Field Detail

<private> _objAllJsAjax

Object kocujILV12aAllJsAjax

<private> _objHelper

Object kocujILV12aHelper

<private> _prj

Projects list

<private> _thisFilename

Current script filename

<private> _valsPrefix

Script settings - prefix

<private> _valsSecurity

Script settings - security string

<private> _valsThrowErrors

Script settings - throw errors (true) or not (false)

Method Detail

<private> {Object} _checkAddProject(projectId)

Check arguments for adding project

Parameters:
{string} projectId: Project identifier

Throws:
{kocujILV12aCException}: kocujILV12aExceptionCode.EMPTY_PROJECT_ID if project identifier entered in projectId is empty

Returns:: {Object} Parsed arguments for adding project

<private> {string} _getHTMLNameMessage(projectId, messageId)

Get HTML prefix for message

Parameters:
{string} projectId: Project identifier
{string} messageId: Message identifier

Returns:: {string} HTML prefix for message review

<private> {string} _getHTMLPrefix(projectId)

Get HTML prefix

Parameters:
{string} projectId: Project identifier

Returns:: {string} HTML prefix

<private> {string} _parseProjectId(projectId)

Parse project identifier

Parameters:
{string} projectId: Project identifier

Throws:
{kocujILV12aCException}: kocujILV12aExceptionCode.EMPTY_PROJECT_ID if project identifier entered in projectId is empty

Returns:: {string} Parsed project identifier

<private> {void} _throwError(codeString, param)

Throw an error if debugging is enabled

Parameters:
{string} codeString: Error code in string format
{string} param Optional: Parameter for error information

Returns:: {void}

{void} addMessageCloseButton(projectId, messageId)

Add close button for message

Parameters:
{string} projectId: Project identifier
{string} messageId: Message identifier

Returns:: {void}

{void} addProject(projectId)

Add project

Parameters:
{string} projectId: Project identifier

Throws:
{kocujILV12aCException}: kocujILV12aExceptionCode.PROJECT_ALREADY_EXISTS if project identifier entered in projectId already exists

Returns:: {void}

{void} addProjectIfNotExists(projectId)

Add project if not exists

Parameters:
{string} projectId: Project identifier

Returns:: {void}

{string} getHTMLSelectorMessage(projectId, messageId)

Get HTML selector for message

Parameters:
{string} projectId: Project identifier
{string} messageId: Message identifier

Returns:: {string} HTML selector for message

Classes

Function Namespace kocujILV12aCBackendMessage