/webportal/src/main/java/au/org/emii/portal/motd/MOTD.java

 1/*
 2 * To change this template, choose Tools | Templates
 3 * and open the template in the editor.
 4 */
 5
 6package au.org.emii.portal.motd;
 7
 8/**
 9 *
10 * @author geoff
11 */
12public interface MOTD {
13
14    /**
15     * Return a value from the motd language pack
16     *
17     * @param key
18     * @return
19     */
20    String getMotd(String key);
21
22    /**
23     * Check if the motd has been enabled
24     *
25     * @return
26     */
27    boolean isMotdEnabled();
28
29    /**
30     * Save the passed in parameters to the MOTD file
31     * @param enabled whether this message is enabled or not
32     * @param title title to display for motd
33     * @param message message to display for motd
34     * @return true if save was successful otherwise false
35     */
36    boolean updateMotd(boolean enabled, String title, String message, String portalUsername);
37
38}