com.google.gerrit.extensions.systemstatus

Class MessageOfTheDay

java.lang.Object

com.google.gerrit.extensions.systemstatus.MessageOfTheDay

public abstract class MessageOfTheDay
extends Object

Supplies a message of the day when the page is first loaded.

 DynamicSet.bind(binder(), MessageOfTheDay.class).to(MyMessage.class);
 

Constructor Summary

Constructors

Constructor and Description
MessageOfTheDay()

Method Summary

Modifier and Type	Method and Description
abstract String	getHtmlMessage() Retrieve the message of the day as an HTML fragment.
abstract String	getMessageId() Unique identifier for this message.
Date	getRedisplay() When should the message be displayed?

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageOfTheDay

public MessageOfTheDay()

Method Detail

getHtmlMessage

public abstract String getHtmlMessage()

Retrieve the message of the day as an HTML fragment.

Returns:

message as an HTML fragment; null if no message is available.

getMessageId

public abstract String getMessageId()

Unique identifier for this message.

Messages with the same identifier will be hidden from the user until redisplay has occurred.

Returns:

unique message identifier. This identifier should be unique within the server.

getRedisplay

public Date getRedisplay()

When should the message be displayed?

Default implementation returns tomorrow at 00:00:00 GMT.

Returns:

a future date after which the message should be redisplayed.