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

Class CustomizedSystemMessages

source code

    object --+    
             |    
SystemMessages --+
                 |
                CustomizedSystemMessages

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

Muntjac gets the SystemMessages from your application by calling a static getSystemMessages() method. By default the Application.getSystemMessages() is used. You can customize this by defining a static MyApplication.getSystemMessages() and returning CustomizedSystemMessages. Note that getSystemMessages() is static - changing the system messages will by default change the message for all users of the application.

The default behavior is to show a notification, and restart the application the the user clicks the message.

Instead of restarting the application, you can set a specific URL that the user is taken to.

Setting both caption and message to null will restart the application (or go to the specified URL) without displaying a notification. set*NotificationEnabled(false) will achieve the same thing.

The situations are:

Instance Methods [hide private]
 
setSessionExpiredURL(self, sessionExpiredURL)
Sets the URL to go to when the session has expired.
source code
 
setSessionExpiredNotificationEnabled(self, sessionExpiredNotificationEnabled)
Enables or disables the notification.
source code
 
setSessionExpiredCaption(self, sessionExpiredCaption)
Sets the caption of the notification.
source code
 
setSessionExpiredMessage(self, sessionExpiredMessage)
Sets the message of the notification.
source code
 
setAuthenticationErrorURL(self, authenticationErrorURL)
Sets the URL to go to when there is a authentication error.
source code
 
setAuthenticationErrorNotificationEnabled(self, authenticationErrorNotificationEnabled)
Enables or disables the notification.
source code
 
setAuthenticationErrorCaption(self, authenticationErrorCaption)
Sets the caption of the notification.
source code
 
setAuthenticationErrorMessage(self, authenticationErrorMessage)
Sets the message of the notification.
source code
 
setCommunicationErrorURL(self, communicationErrorURL)
Sets the URL to go to when there is a communication error.
source code
 
setCommunicationErrorNotificationEnabled(self, communicationErrorNotificationEnabled)
Enables or disables the notification.
source code
 
setCommunicationErrorCaption(self, communicationErrorCaption)
Sets the caption of the notification.
source code
 
setCommunicationErrorMessage(self, communicationErrorMessage)
Sets the message of the notification.
source code
 
setInternalErrorURL(self, internalErrorURL)
Sets the URL to go to when an internal error occurs.
source code
 
setInternalErrorNotificationEnabled(self, internalErrorNotificationEnabled)
Enables or disables the notification.
source code
 
setInternalErrorCaption(self, internalErrorCaption)
Sets the caption of the notification.
source code
 
setInternalErrorMessage(self, internalErrorMessage)
Sets the message of the notification.
source code
 
setOutOfSyncURL(self, outOfSyncURL)
Sets the URL to go to when the client is out-of-sync.
source code
 
setOutOfSyncNotificationEnabled(self, outOfSyncNotificationEnabled)
Enables or disables the notification.
source code
 
setOutOfSyncCaption(self, outOfSyncCaption)
Sets the caption of the notification.
source code
 
setOutOfSyncMessage(self, outOfSyncMessage)
Sets the message of the notification.
source code
 
setCookiesDisabledURL(self, cookiesDisabledURL)
Sets the URL to redirect to when the browser has cookies disabled.
source code
 
setCookiesDisabledNotificationEnabled(self, cookiesDisabledNotificationEnabled)
Enables or disables the notification for "cookies disabled" messages.
source code
 
setCookiesDisabledCaption(self, cookiesDisabledCaption)
Sets the caption of the "cookies disabled" notification.
source code
 
setCookiesDisabledMessage(self, cookiesDisabledMessage)
Sets the message of the "cookies disabled" notification.
source code

Inherited from SystemMessages: __init__, getAuthenticationErrorCaption, getAuthenticationErrorMessage, getAuthenticationErrorURL, getCommunicationErrorCaption, getCommunicationErrorMessage, getCommunicationErrorURL, getCookiesDisabledCaption, getCookiesDisabledMessage, getCookiesDisabledURL, getInternalErrorCaption, getInternalErrorMessage, getInternalErrorURL, getOutOfSyncCaption, getOutOfSyncMessage, getOutOfSyncURL, getSessionExpiredCaption, getSessionExpiredMessage, getSessionExpiredURL, isAuthenticationErrorNotificationEnabled, isCommunicationErrorNotificationEnabled, isCookiesDisabledNotificationEnabled, isInternalErrorNotificationEnabled, isOutOfSyncNotificationEnabled, isSessionExpiredNotificationEnabled

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]

setSessionExpiredURL(self, sessionExpiredURL)

source code 

Sets the URL to go to when the session has expired.

Parameters:
  • sessionExpiredURL - the URL to go to, or null to reload current

setSessionExpiredNotificationEnabled(self, sessionExpiredNotificationEnabled)

source code 

Enables or disables the notification. If disabled, the set URL (or current) is loaded directly when next transaction between server and client happens.

Parameters:
  • sessionExpiredNotificationEnabled - true = enabled, false = disabled

setSessionExpiredCaption(self, sessionExpiredCaption)

source code 

Sets the caption of the notification. Set to null for no caption. If both caption and message are null, client automatically forwards to sessionExpiredUrl after timeout timer expires. Timer uses value read from HTTPSession.getMaxInactiveInterval()

Parameters:
  • sessionExpiredCaption - the caption

setSessionExpiredMessage(self, sessionExpiredMessage)

source code 

Sets the message of the notification. Set to null for no message. If both caption and message are null, client automatically forwards to sessionExpiredUrl after timeout timer expires. Timer uses value read from HTTPSession.getMaxInactiveInterval()

Parameters:
  • sessionExpiredMessage - the message

setAuthenticationErrorURL(self, authenticationErrorURL)

source code 

Sets the URL to go to when there is a authentication error.

Parameters:
  • authenticationErrorURL - the URL to go to, or null to reload current

setAuthenticationErrorNotificationEnabled(self, authenticationErrorNotificationEnabled)

source code 

Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.

Parameters:
  • authenticationErrorNotificationEnabled - true = enabled, false = disabled

setAuthenticationErrorCaption(self, authenticationErrorCaption)

source code 

Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;

Parameters:
  • authenticationErrorCaption - the caption

setAuthenticationErrorMessage(self, authenticationErrorMessage)

source code 

Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;

Parameters:
  • authenticationErrorMessage - the message

setCommunicationErrorURL(self, communicationErrorURL)

source code 

Sets the URL to go to when there is a communication error.

Parameters:
  • communicationErrorURL - the URL to go to, or null to reload current

setCommunicationErrorNotificationEnabled(self, communicationErrorNotificationEnabled)

source code 

Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.

Parameters:
  • communicationErrorNotificationEnabled - true = enabled, false = disabled

setCommunicationErrorCaption(self, communicationErrorCaption)

source code 

Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;

Parameters:
  • communicationErrorCaption - the caption

setCommunicationErrorMessage(self, communicationErrorMessage)

source code 

Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;

Parameters:
  • communicationErrorMessage - the message

setInternalErrorURL(self, internalErrorURL)

source code 

Sets the URL to go to when an internal error occurs.

Parameters:
  • internalErrorURL - the URL to go to, or null to reload current

setInternalErrorNotificationEnabled(self, internalErrorNotificationEnabled)

source code 

Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.

Parameters:
  • internalErrorNotificationEnabled - true = enabled, false = disabled

setInternalErrorCaption(self, internalErrorCaption)

source code 

Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;

Parameters:
  • internalErrorCaption - the caption

setInternalErrorMessage(self, internalErrorMessage)

source code 

Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;

Parameters:
  • internalErrorMessage - the message

setOutOfSyncURL(self, outOfSyncURL)

source code 

Sets the URL to go to when the client is out-of-sync.

Parameters:
  • outOfSyncURL - the URL to go to, or null to reload current

setOutOfSyncNotificationEnabled(self, outOfSyncNotificationEnabled)

source code 

Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.

Parameters:
  • outOfSyncNotificationEnabled - true = enabled, false = disabled

setOutOfSyncCaption(self, outOfSyncCaption)

source code 

Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;

Parameters:
  • outOfSyncCaption - the caption

setOutOfSyncMessage(self, outOfSyncMessage)

source code 

Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;

Parameters:
  • outOfSyncMessage - the message

setCookiesDisabledURL(self, cookiesDisabledURL)

source code 

Sets the URL to redirect to when the browser has cookies disabled.

Parameters:
  • cookiesDisabledURL - the URL to redirect to, or null to reload the current URL

setCookiesDisabledNotificationEnabled(self, cookiesDisabledNotificationEnabled)

source code 

Enables or disables the notification for "cookies disabled" messages. If disabled, the URL returned by getCookiesDisabledURL is loaded directly.

Parameters:
  • cookiesDisabledNotificationEnabled - true to enable "cookies disabled" messages, false otherwise

setCookiesDisabledCaption(self, cookiesDisabledCaption)

source code 

Sets the caption of the "cookies disabled" notification. Set to null for no caption. If both caption and message is null, the notification is disabled.

Parameters:
  • cookiesDisabledCaption - the caption for the "cookies disabled" notification

setCookiesDisabledMessage(self, cookiesDisabledMessage)

source code 

Sets the message of the "cookies disabled" notification. Set to null for no message. If both caption and message is null, the notification is disabled.

Parameters:
  • cookiesDisabledMessage - the message for the "cookies disabled" notification