com.uc4.communication

Class MessageSettings

java.lang.Object

com.uc4.communication.MessageSettings

public class MessageSettings
extends java.lang.Object

This class represents the message window settings. These settings can be found in the User Interface - Options - Settings - Message Window

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageSettings.OpenMessages Automatically open messages.

Method Summary

Modifier and Type	Method and Description
UC4ObjectName	getGroup() Returns the name of the user group if own messages are selected (EverythingInClient is set to false).
int	getMaxNumber() Returns the maximum number of messages in the Message Window.
MessageSettings.OpenMessages	getOpenAutomatically() Returns whether the Message Window should open automatically for incoming information or error messages.
boolean	isAdministratorMessages()
boolean	isErrorAndWarningOnly() Return the option "Display errors and Warnings only".
boolean	isEverythingInClient() Returns the scope of subscribed messages.
boolean	isSecurityMessages()
boolean	isShowUnreadAfterLogon() Returns if unread messages should be shown after logon.
void	setAdministratorMessages(boolean administratorMessages) Defines if administrator messages should be shown in the message window.
void	setErrorAndWarningOnly(boolean errorAndWarningOnly) Sets the option "Display errors and Warnings only".
void	setEverythingInClient(boolean everythingInClient) Defines which messages should be shown in the message window.
void	setGroup(UC4ObjectName group) Sets the name of the user group if own messages are selected (EverythingInClient is set to false).
void	setMaxNumber(int maxNumber) Sets the maximum number of messages in the Message Window.
void	setOpenAutomatically(MessageSettings.OpenMessages openAutomatically) Specifies whether the Message Window should open automatically for incoming information or error messages.
void	setSecurityMessages(boolean securityMessages) Defines if security messages should be shown in the message window.
void	setShowUnreadAfterLogon(boolean showUnreadAfterLogon) Defines if unread messages should be shown after logon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isErrorAndWarningOnly

public boolean isErrorAndWarningOnly()

Return the option "Display errors and Warnings only".

Returns:

true if only errors and warnings are shown in the message window, false if information messages are also displayed

setErrorAndWarningOnly

public void setErrorAndWarningOnly(boolean errorAndWarningOnly)

Sets the option "Display errors and Warnings only".

Parameters:

errorAndWarningOnly - if true only errors and warnings are shown in the message window

isEverythingInClient

public boolean isEverythingInClient()

Returns the scope of subscribed messages. if the parameter everythingInClient is set to false only own messages (and optionally messages of a defined user group) are displayed.

Returns:

true if everything in the current client is shown in the message window, false for own + group messages only

setEverythingInClient

public void setEverythingInClient(boolean everythingInClient)

Defines which messages should be shown in the message window. if the parameter everythingInClient is set to false only own messages (and optionally messages of a defined user group) are displayed.

Parameters:

everythingInClient - true if everything in the current client should be shown in the message window, false for own + group messages only

getGroup

public UC4ObjectName getGroup()

Returns the name of the user group if own messages are selected (EverythingInClient is set to false). If no user group is set an empty UC4ObjectName instance is returned.

Returns:

Name of the user group never null

setGroup

public void setGroup(UC4ObjectName group)

Sets the name of the user group if own messages are selected (EverythingInClient is set to false).

Parameters:

group - Name of the user group

isAdministratorMessages

public boolean isAdministratorMessages()

Returns:

true if administrator messages are shown in the message window, false otherwise

setAdministratorMessages

public void setAdministratorMessages(boolean administratorMessages)

Defines if administrator messages should be shown in the message window.

Parameters:

administratorMessages - true if administrator messages should be shown in the message window, false otherwise

isSecurityMessages

public boolean isSecurityMessages()

Returns:

true if security messages are shown in the message window, false otherwise

setSecurityMessages

public void setSecurityMessages(boolean securityMessages)

Defines if security messages should be shown in the message window.

Parameters:

securityMessages - true if security messages should be shown in the message window, false otherwise

getOpenAutomatically

public MessageSettings.OpenMessages getOpenAutomatically()

Returns whether the Message Window should open automatically for incoming information or error messages.

Returns:

Open message window condition

setOpenAutomatically

public void setOpenAutomatically(MessageSettings.OpenMessages openAutomatically)

Specifies whether the Message Window should open automatically for incoming information or error messages.

Parameters:

openAutomatically - Open message window condition

getMaxNumber

public int getMaxNumber()

Returns the maximum number of messages in the Message Window.

Returns:

Integer between 0 and 999

setMaxNumber

public void setMaxNumber(int maxNumber)

Sets the maximum number of messages in the Message Window.

Parameters:

maxNumber - Integer between 0 and 999

isShowUnreadAfterLogon

public boolean isShowUnreadAfterLogon()

Returns if unread messages should be shown after logon.

Returns:

true if unread messages should be shown, false otherwise

setShowUnreadAfterLogon

public void setShowUnreadAfterLogon(boolean showUnreadAfterLogon)

Defines if unread messages should be shown after logon.

Parameters:

showUnreadAfterLogon - true if unread messages should be shown, false otherwise