com.jalios.jcms
Class AdminNotes

java.lang.Object
  extended by com.jalios.jcms.AdminNotes
All Implemented Interfaces:
JcmsConstants, JaliosConstants, Serializable

public class AdminNotes
extends Object
implements JcmsConstants, Serializable

This class manage admin notes of JCMS.

Since:
jcms-5.5.0
Version:
$Revision: 32250 $
Author:
Olivier Jaquemet
See Also:
Serialized Form

Field Summary
protected  Channel channel
           
protected static AdminNotes instance
           
protected  JProperties properties
           
protected  File propertiesFile
           
static String REVISION
           
 
Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
 
Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR
 
Method Summary
 String get(String jsp)
           
static AdminNotes getInstance()
           
static void getNote(String jsp)
          Convenient static method to access singleton method get(String).
static void saveNote(String jsp, String text)
          Convenient static method to access singleton method updateNote(String, String).
 void updateNote(String jsp, String text)
          Updates the note for the given jsp.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

channel

protected transient Channel channel

propertiesFile

protected transient File propertiesFile

properties

protected transient JProperties properties

instance

protected static AdminNotes instance
Method Detail

updateNote

public void updateNote(String jsp,
                       String text)
Updates the note for the given jsp. The note is updated only if it differs from the last note of this JSP. The change is immediately store on disk.

Parameters:
jsp - the resource path of the jsp to which associate the note.
text - of the note

get

public String get(String jsp)
Parameters:
jsp - the resource path of the jsp to which associate the note.
Returns:
the note associated with the given jsp, or empty string "" if no notes is available.

getInstance

public static AdminNotes getInstance()

saveNote

public static void saveNote(String jsp,
                            String text)
Convenient static method to access singleton method updateNote(String, String).

See Also:
updateNote(String, String)

getNote

public static void getNote(String jsp)
Convenient static method to access singleton method get(String).

See Also:
get(String)


Copyright © 2001-2010 Jalios SA. All Rights Reserved.