uiexception.UiException Class Reference

This exception should be used for functionnal error management, at least in the GUI part of the application, for example to set user oriented messages at point of exception raise. More...

Inheritance diagram for uiexception.UiException:

Public Member Functions
def	__init__
	Canonical constructor. More...
def	setUIMessage
def	getUIMessage
def	setType
	Specify the type of this exception. More...
def	getType
def	__str__

Static Public Attributes
tuple	TYPES

Detailed Description

This exception should be used for functionnal error management, at least in the GUI part of the application, for example to set user oriented messages at point of exception raise.

Warning

The exception should NOT be used to hide defaults in the algorithm, but only predicted error in the specified use case.

Constructor & Destructor Documentation

def uiexception.UiException.__init__	(		self,
			message,
			type = TYPES.USER
	)

Canonical constructor.

Member Function Documentation

def uiexception.UiException.setType	(		self,
			type
	)

Specify the type of this exception.

To be choosen in the TYPES list.

Field Documentation

tuple uiexception.UiException.TYPES

static

Initial value:

= Enumerate([
        'USER',  # This type should be displayed to end user using a dialog box
        'ADMIN', # This type should be displayed to admin user in console log
        'DEVEL'  # This type should be displayed to developer only
    ])