|
| |
|
| java.lang.Object
 org.opencms.db.CmsLoginMessage
| CmsLoginMessage | | public class CmsLoginMessage (Code) | | A message to display when a user logs in to the system.
author:
Alexander Kandzior
version:
$Revision: 1.6 $
since:
6.0.0 |
| Field Summary | |
| final public static long | DEFAULT_TIME_END
The default end time (if none has been set). | | final public static long | DEFAULT_TIME_START
The default start time (if none has been set). |
| DEFAULT_TIME_END | | final public static long DEFAULT_TIME_END(Code) | | The default end time (if none has been set). This is December 31, 2039.
|
| DEFAULT_TIME_START | | final public static long DEFAULT_TIME_START(Code) | | The default start time (if none has been set). This is January 1, 2000.
|
| CmsLoginMessage | | public CmsLoginMessage()(Code) | | Creates a new login message with all default values.
|
| CmsLoginMessage | | public CmsLoginMessage(long timeStart, long timeEnd, String message, boolean loginForbidden)(Code) | | Creates a new login message with the given parameters.
Parameters:
timeStart - the time when to start displaying this message
Parameters:
timeEnd - the time when to finish displaying this message
Parameters:
message - the message to display
Parameters:
loginForbidden - controls if logins are forbidden while this message is active |
| CmsLoginMessage | | public CmsLoginMessage(String message, boolean loginForbidden)(Code) | | Creates a new login message with the given parameters.
Parameters:
message - the message to display
Parameters:
loginForbidden - controls if logins are forbidden while this message is active |
| getMessage | | public String getMessage()(Code) | | Returns the message.
the message |
| getTimeEnd | | public long getTimeEnd()(Code) | | Returns the time the message ends.
the time the message ends |
| getTimeStart | | public long getTimeStart()(Code) | | Returns the time the message starts.
the time the message starts |
| isActive | | public boolean isActive()(Code) | | Returns true if this message is currently active.
A message is active if it is enabled and
the current time is after the message start time and before the message end time.
true if this message is currently active |
| isEnabled | | public boolean isEnabled()(Code) | | Returns true if this login message is the enabled.
true if this login message is the enabled |
| isLoginForbidden | | public boolean isLoginForbidden()(Code) | | Returns true if logins are forbidden while this message is active.
true if logins are forbidden while this message is active |
| setEnabled | | public void setEnabled(boolean enabled)(Code) | | Sets the enabled status of this message.
Parameters:
enabled - the enabled status to set |
| setFrozen | | protected void setFrozen()(Code) | | Freezes the configuration of this login message object to prevent later changes.
|
| setLoginForbidden | | public void setLoginForbidden(boolean loginForbidden)(Code) | | Sets the flag that controls if logins are forbidden while this message is active.
Parameters:
loginForbidden - the flag to set |
| setMessage | | public void setMessage(String message)(Code) | | Sets the message to display.
Parameters:
message - the message to set |
| setTimeEnd | | public void setTimeEnd(long timeEnd)(Code) | | Sets the time when to finish displaying this message.
Parameters:
timeEnd - the time to set |
| setTimeStart | | public void setTimeStart(long timeStart)(Code) | | Sets the time when to start displaying this message.
Parameters:
timeStart - the time to set |
|
|
|