Murl Engine Lua Addon API  Version 1.0 beta
Murl.Result

A class for retrieving the result of some operation.


Table members

Functions


Murl.Result.new()

The default constructor

Murl.Result new()

Returns
Murl.Result


Methods


Clear()

Clear the result (Set OK).

Clear()


Set(other)

Set a result from a given other result.

Set(Murl.Result other)

Parameters
otherThe result object to copy from.

Append(other)

Append a given other result.

Append(Murl.Result other)

Parameters
otherThe result object to copy from.

IsClear()

Check if the contained result is OK.

Boolean IsClear()

Returns
Boolean true if OK.

HasInfo()

Check if the result contains at least one info.

Boolean HasInfo()

Returns
Boolean true if error.

GetNumberOfInfos()

Get the number of infos.

Integer GetNumberOfInfos()

Returns
Integer The number of infos.

GetInfoCode(index)

Get the code of a info at a given index.

Murl.IEnums.ResultCode GetInfoCode(Integer index)

Parameters
indexThe info index, in the range [0..GetNumberOfInfos()-1].
Returns
Murl.IEnums.ResultCode The result code.

GetInfoMessage(index)

Get the message of a info at a given index.

String GetInfoMessage(Integer index)

Parameters
indexThe info index, in the range [0..GetNumberOfInfos()-1].
Returns
String The message.

GetAllInfoMessages()

Get all info messages. This method concatenates all existing infos to one string, each one delimited by a single line feed character.

String GetAllInfoMessages()

Returns
String The concatenated info messages.

HasWarning()

Check if the result contains at least one warning.

Boolean HasWarning()

Returns
Boolean true if error.

GetNumberOfWarnings()

Get the number of warnings.

Integer GetNumberOfWarnings()

Returns
Integer The number of warnings.

GetWarningCode(index)

Get the code of a warning at a given index.

Murl.IEnums.ResultCode GetWarningCode(Integer index)

Parameters
indexThe warning index, in the range [0..GetNumberOfWarnings()-1].
Returns
Murl.IEnums.ResultCode The result code.

GetWarningMessage(index)

Get the message of a warning at a given index.

String GetWarningMessage(Integer index)

Parameters
indexThe warning index, in the range [0..GetNumberOfWarnings()-1].
Returns
String The message.

GetAllWarningMessages()

Get all warning messages. This method concatenates all existing warnings to one string, each one delimited by a single line feed character.

String GetAllWarningMessages()

Returns
String The concatenated warning messages.

HasError()

Check if the result contains at least one error.

Boolean HasError()

Returns
Boolean true if error.

GetNumberOfErrors()

Get the number of errors.

Integer GetNumberOfErrors()

Returns
Integer The number of errors.

GetErrorCode(index)

Get the code of a error at a given index.

Murl.IEnums.ResultCode GetErrorCode(Integer index)

Parameters
indexThe error index, in the range [0..GetNumberOfErrors()-1].
Returns
Murl.IEnums.ResultCode The result code.

GetErrorMessage(index)

Get the message of a error at a given index.

String GetErrorMessage(Integer index)

Parameters
indexThe error index, in the range [0..GetNumberOfErrors()-1].
Returns
String The message.

GetAllErrorMessages()

Get all error messages. This method concatenates all existing errors to one string, each one delimited by a single line feed character.

String GetAllErrorMessages()

Returns
String The concatenated error messages.

GetAllMessages()

Get all messages. This method concatenates all existing errors, warnings and infos to one string, each one delimited by a single line feed character.

String GetAllMessages()

Returns
String The concatenated messages.