Function Namespace kocujILV12aCBackendUpdateMessage

kocujILV12aCBackendReviewMessage
Defined in: update-message.js.

Function Namespace Summary
Constructor Attributes	Constructor Name and Description
	kocujILV12aCBackendUpdateMessage() Update 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>	_parseProjectId(projectId) Parse project identifier
<private>	_throwError(codeString, param) Throw an error if debugging is enabled
	addProject(projectId) Add project
	addProjectIfNotExists(projectId) Add project if not exists
	sendCloseEvent(projectId) Close window

Function Namespace Detail

kocujILV12aCBackendUpdateMessage()

Update 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} _parseProjectId(projectId)

Parse project identifier

Parameters:
{string} projectId: Project identifier

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

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} 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}

{void} sendCloseEvent(projectId)

Close window

Parameters:
{string} projectId: Project identifier

Returns:: {void}

Classes

Function Namespace kocujILV12aCBackendUpdateMessage