Package muntjac :: Module messages :: Class SystemMessages
[hide private]
[frames] | no frames]

Class SystemMessages

source code

object --+
         |
        SystemMessages
Known Subclasses:

Contains the system messages used to notify the user about various critical situations that can occur.

Customize by overriding the static Application.getSystemMessages() and returning CustomizedSystemMessages.

The defaults defined in this class are:

Instance Methods [hide private]
 
__init__(self)
Use CustomizedSystemMessages to customize
source code
 
getSessionExpiredURL(self)
Returns: null to indicate that the application will be restarted after session expired message has been shown.
source code
 
isSessionExpiredNotificationEnabled(self)
Returns: true to show session expiration message.
source code
 
getSessionExpiredCaption(self)
Returns: "" to show no caption.
source code
 
getSessionExpiredMessage(self)
Returns: "Take note of any unsaved data, and <u>click here</u> to continue."
source code
 
getCommunicationErrorURL(self)
Returns: null to reload the application after communication error message.
source code
 
isCommunicationErrorNotificationEnabled(self)
Returns: true to show the communication error message.
source code
 
getCommunicationErrorCaption(self)
Returns: "Communication problem"
source code
 
getCommunicationErrorMessage(self)
Returns: "Take note of any unsaved data, and <u>click here</u> to continue."
source code
 
getAuthenticationErrorURL(self)
Returns: null to reload the application after authentication error message.
source code
 
isAuthenticationErrorNotificationEnabled(self)
Returns: true to show the authentication error message.
source code
 
getAuthenticationErrorCaption(self)
Returns: "Authentication problem"
source code
 
getAuthenticationErrorMessage(self)
Returns: "Take note of any unsaved data, and <u>click here</u> to continue."
source code
 
getInternalErrorURL(self)
Returns: null to reload the current URL after internal error message has been shown.
source code
 
isInternalErrorNotificationEnabled(self)
Returns: true to enable showing of internal error message.
source code
 
getInternalErrorCaption(self)
Returns: "Internal error"
source code
 
getInternalErrorMessage(self)
Returns: "Please notify the administrator.<br/> Take note of any unsaved data, and <u>click here</u> to continue."
source code
 
getOutOfSyncURL(self)
Returns: null to reload the application after out of sync message.
source code
 
isOutOfSyncNotificationEnabled(self)
Returns: true to enable showing out of sync message
source code
 
getOutOfSyncCaption(self)
Returns: "Out of sync"
source code
 
getOutOfSyncMessage(self)
Returns: "Something has caused us to be out of sync with the server.<br/> Take note of any unsaved data, and <u>click here</u> to re-sync."
source code
 
getCookiesDisabledURL(self)
Returns the URL the user should be redirected to after dismissing the "you have to enable your cookies" message.
source code
 
isCookiesDisabledNotificationEnabled(self)
Determines if "cookies disabled" messages should be shown to the end user or not.
source code
 
getCookiesDisabledCaption(self)
Returns the caption of the message shown to the user when cookies are disabled in the browser.
source code
 
getCookiesDisabledMessage(self)
Returns the message shown to the user when cookies are disabled in the browser.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

Use CustomizedSystemMessages to customize

Overrides: object.__init__

getSessionExpiredURL(self)

source code 
Returns:
null to indicate that the application will be restarted after session expired message has been shown.

isSessionExpiredNotificationEnabled(self)

source code 
Returns:
true to show session expiration message.

getSessionExpiredCaption(self)

source code 
Returns:
"" to show no caption.

getSessionExpiredMessage(self)

source code 
Returns:
"Take note of any unsaved data, and <u>click here</u> to continue."

getCommunicationErrorURL(self)

source code 
Returns:
null to reload the application after communication error message.

isCommunicationErrorNotificationEnabled(self)

source code 
Returns:
true to show the communication error message.

getCommunicationErrorCaption(self)

source code 
Returns:
"Communication problem"

getCommunicationErrorMessage(self)

source code 
Returns:
"Take note of any unsaved data, and <u>click here</u> to continue."

getAuthenticationErrorURL(self)

source code 
Returns:
null to reload the application after authentication error message.

isAuthenticationErrorNotificationEnabled(self)

source code 
Returns:
true to show the authentication error message.

getAuthenticationErrorCaption(self)

source code 
Returns:
"Authentication problem"

getAuthenticationErrorMessage(self)

source code 
Returns:
"Take note of any unsaved data, and <u>click here</u> to continue."

getInternalErrorURL(self)

source code 
Returns:
null to reload the current URL after internal error message has been shown.

isInternalErrorNotificationEnabled(self)

source code 
Returns:
true to enable showing of internal error message.

getInternalErrorCaption(self)

source code 
Returns:
"Internal error"

getInternalErrorMessage(self)

source code 
Returns:
"Please notify the administrator.<br/> Take note of any unsaved data, and <u>click here</u> to continue."

getOutOfSyncURL(self)

source code 
Returns:
null to reload the application after out of sync message.

isOutOfSyncNotificationEnabled(self)

source code 
Returns:
true to enable showing out of sync message

getOutOfSyncCaption(self)

source code 
Returns:
"Out of sync"

getOutOfSyncMessage(self)

source code 
Returns:
"Something has caused us to be out of sync with the server.<br/> Take note of any unsaved data, and <u>click here</u> to re-sync."

getCookiesDisabledURL(self)

source code 

Returns the URL the user should be redirected to after dismissing the "you have to enable your cookies" message. Typically null.

Returns:
A URL the user should be redirected to after dismissing the message or null to reload the current URL.

isCookiesDisabledNotificationEnabled(self)

source code 

Determines if "cookies disabled" messages should be shown to the end user or not. If the notification is disabled the user will be immediately redirected to the URL returned by getCookiesDisabledURL.

Returns:
true to show "cookies disabled" messages to the end user, false to redirect to the given URL directly

getCookiesDisabledCaption(self)

source code 

Returns the caption of the message shown to the user when cookies are disabled in the browser.

Returns:
The caption of the "cookies disabled" message

getCookiesDisabledMessage(self)

source code 

Returns the message shown to the user when cookies are disabled in the browser.

Returns:
The "cookies disabled" message