API/libsapojs/SAPO/Utility/Error

[Elements] are optional

Class SAPO.Utility.Error


class SAPO.Utility.Error
Error Handling utilities
Defined in Utility/Error/0.1/lib.js

Function Summary
Object parseErrorHandle (Object ErrorHandle, [String className])
Object show (Object eventHandler, [Object args])
Function that returns the error Object
showAlert (Object eventHandler, [Object args])
Function that shows the error in a alert
Function to be used when broker is active
showElement (Object eventHandler, DOMElement|String el, [Object args])
Function that shows the error in a dom element
showWindow (Object eventHandler, [Object args])
Function that shows the error in a new window

Function Details

function parseErrorHandle

Object parseErrorHandle(Object ErrorHandle, [String className])
Parameters:
ErrorHandle
[className]
Returns:
elements selected in error object

function show

Object show(Object eventHandler, [Object args])
Function that returns the error Object
Parameters:
eventHandler
[args] - debug : 1 to print complete object - firebug: 1 to console.log the object - className: the name of the class - method : method within class - errorMsg : Message to show the user
Returns:
error object

function showAlert

showAlert(Object eventHandler, [Object args])
Function that shows the error in a alert
Parameters:
eventHandler
[args] - debug : 1 to print complete object - firebug: 1 to console.log the object - className: the name of the class - method : method within class - errorMsg : Message to show the user

function showBroker

showBroker()
Function to be used when broker is active

function showElement

showElement(Object eventHandler, DOMElement|String el, [Object args])
Function that shows the error in a dom element
Parameters:
eventHandler
el - the dom element or the id string of the element
[args] - debug : 1 to print complete object - firebug: 1 to console.log the object - className: the name of the class - method : method within class - errorMsg : Message to show the user

function showWindow

showWindow(Object eventHandler, [Object args])
Function that shows the error in a new window
Parameters:
eventHandler
[args] - debug : 1 to print complete object - firebug: 1 to console.log the object - className: the name of the class - method : method within class - errorMsg : Message to show the user