org.sakaiproject.announcement.tool
Class AnnouncementAction

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.sakaiproject.vm.ComponentServlet
              org.sakaiproject.vm.VmServlet
                  org.sakaiproject.cheftool.VmServlet
                      org.sakaiproject.cheftool.ToolServlet
                          org.sakaiproject.cheftool.VelocityPortletPaneledAction
                              org.sakaiproject.cheftool.PagedResourceActionII
                                  org.sakaiproject.announcement.tool.AnnouncementAction

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class AnnouncementAction
extends org.sakaiproject.cheftool.PagedResourceActionII

AnnouncementAction is an implementation of Announcement service, which provides the complete function of announcements. User could check the announcements, create own new and manage all the announcement items, under certain permission check.

See Also:

Serialized Form

Nested Class Summary

static class

AnnouncementAction.AnnouncementWrapper Decorator for the "Message" class.

Nested classes/interfaces inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

org.sakaiproject.cheftool.VelocityPortletPaneledAction.MyLogger

Field Summary

protected static String	STATE_INITED
static String	STATE_MESSAGE
static String	STATE_MESSAGES

Fields inherited from class org.sakaiproject.cheftool.PagedResourceActionII

DEFAULT_PAGE_SIZE, FORM_PAGE_NUMBER, FORM_SEARCH, PAGESIZES, PARAM_PAGESIZE, rb_praII, STATE_CURRENT_PAGE, STATE_FIRST_PAGE_EXISTS, STATE_GO_FIRST_PAGE, STATE_GO_LAST_PAGE, STATE_GO_NEXT, STATE_GO_NEXT_PAGE, STATE_GO_PREV, STATE_GO_PREV_PAGE, STATE_GOTO_PAGE, STATE_LAST_PAGE_EXISTS, STATE_MANUAL_REFRESH, STATE_NEXT_EXISTS, STATE_NEXT_PAGE_EXISTS, STATE_NUM_MESSAGES, STATE_PAGESIZE, STATE_PREV_EXISTS, STATE_PREV_PAGE_EXISTS, STATE_SEARCH, STATE_TOP_PAGE_MESSAGE, STATE_TOTAL_PAGENUMBER, STATE_VIEW_ID

Fields inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

ATTR_CONFIG, ATTR_CONTEXT, ATTR_FRAME_FOCUS, ATTR_FRAME_REFRESH, ATTR_PORTLET, ATTR_RUNDATA, ATTR_TOP_REFRESH, BUTTON, CONTEXT_SITE_COLLECTION_ID, CONTEXT_SITE_COLLECTION_URL, HELPER_LINK_MODE, HELPER_MODE_DONE, LAYOUT_MAIN, Log, MODE_OPTIONS, SAKAI_CSRF_TOKEN, STATE_ACTION, STATE_FLOAT, STATE_HELPER, STATE_MODE, STATE_NEW_PANEL, STATE_OBSERVER, STATE_OBSERVER2, STATE_PRESENCE_OBSERVER, STATE_TOOL

Fields inherited from class org.sakaiproject.cheftool.ToolServlet

ALERT_ATTR, ALERT_STATE_INITED, HELPER_ID, MAIN_PANEL, MENU_ATTR, PARAM_ACTION, PARAM_ACTION_COMBO, TITLE_PANEL, TOOL_MODE_ATTR, TOOL_MODE_DEFAULT

Fields inherited from class org.sakaiproject.cheftool.VmServlet

m_validator

Fields inherited from class org.sakaiproject.vm.ComponentServlet

ATTR_PARAMS

Constructor Summary

AnnouncementAction()

Method Summary

protected String	buildCancelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, AnnouncementActionState state) Build the context for cancelling the operation and going back to list view
protected String	buildDeleteAnnouncementContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, AnnouncementActionState state) Build the context for asking for the delete confirmation
String	buildMainPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState sstate) Default is to use when Portal starts up
String	buildMergeContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData runData, AnnouncementActionState state, org.sakaiproject.event.api.SessionState sstate) Build the context for showing merged view
String	buildOptionsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData runData, org.sakaiproject.event.api.SessionState state) Setup for the options panel.
protected String	buildPreviewContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, AnnouncementActionState state) Build the context for preview an attachment
String	buildReorderContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData runData, AnnouncementActionState state, org.sakaiproject.event.api.SessionState sstate) Build the context for showing merged view
protected String	buildReviseAnnouncementContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, AnnouncementActionState state, org.sakaiproject.event.api.SessionState sstate) Build the context for revising the announcement
protected String	buildShowMetadataContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, AnnouncementActionState state, org.sakaiproject.event.api.SessionState sstate) Build the context for viewing announcement content
void	buildSortedContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState sstate)
void	doAnnouncement_form(org.sakaiproject.cheftool.RunData data, org.sakaiproject.cheftool.Context context) Dispatcher function for various actions on add/revise announcement page
void	doAttachments(org.sakaiproject.cheftool.RunData data, org.sakaiproject.cheftool.Context context)
void	doCancel(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doCancel requested, corresponding to chef_announcement "eventSubmit_doCancel"
void	doDelete_announcement_link(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doDelete_announcement_link requested, corresponding to chef_announcements the link of deleting announcement item
void	doDelete(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when ddoDelete requested, to perform deletion corresponding to chef_announcements-delete "eventSubmit_doDelete"
void	doDeleteannouncement(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doDeleteannouncement requested, corresponding to chef_announcements or chef_announcements-metadata menu "Delete"
void	doLinkcancel(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doLinkcancel requested, corresponding to chef_announcement "eventSubmit_doLinkcancel"
void	doMerge(org.sakaiproject.cheftool.RunData runData, org.sakaiproject.cheftool.Context context) Handle the "Merge" button on the toolbar
void	doNewannouncement(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doNewannouncement requested, corresponding to chef_announcements menu "New..."
void	doNext_message(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Responding to the request of going to next message
void	doOptions(org.sakaiproject.cheftool.RunData runData, org.sakaiproject.cheftool.Context context)
void	doOptionsUpdate(org.sakaiproject.cheftool.RunData runData, org.sakaiproject.cheftool.Context context) This handles the "doUpdate" if we're in a processing an update from the options page.
void	doPermissions(org.sakaiproject.cheftool.RunData data, org.sakaiproject.cheftool.Context context) Fire up the permissions editor
void	doPost(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doPost requested, corresponding to chef_announcements-revise or -preview "eventSubmit_doPost"
void	doPrev_message(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Responding to the request of going to previous message
void	doPreviewrevise(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doPreviewrevise requested from preview status corresponding to chef_announcements-preview "eventSubmit_doPreviewrevise"
void	doReorder(org.sakaiproject.cheftool.RunData runData, org.sakaiproject.cheftool.Context context) Handle the "Reorder" button on the toolbar
void	doReorderUpdate(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) This handles the "doUpdate" if we're processing an update from the "reorder" page.
void	doReviseannouncement(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doReviseannouncement requested, corresponding to chef_announcements the link of any draft announcement item
void	doReviseannouncementfrommenu(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doReviseannouncementfrommenu requested, corresponding to chef_announcements.vm and -metadata.vm menu "Revise"
void	doRevisepreview(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doRevisePreview requested, corresponding to chef_announcements-revise "eventSubmit_doRevisePreview" from revise view to preview view
void	doSavedraft(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Action is to use when doSavedraft requested, corresponding to chef_announcements-preview "eventSubmit_doSavedraft"
void	doShowmetadata(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) corresponding to chef_announcements doShowMetadata
void	doSortbychannel(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by the announcement channel name.
void	doSortbydate(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by the date of the announcement.
void	doSortbyfor(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by for - grouop/site/public
void	doSortbyfrom(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by from - the author
void	doSortbygroupdescription(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by group description
void	doSortbygrouptitle(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by group title
void	doSortbymessage_order(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context)
void	doSortbypublic(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by public
void	doSortbyreleasedate(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context)
void	doSortbyretractdate(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context)
void	doSortbysubject(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context) Do sort by subject
void	doUpdate(org.sakaiproject.cheftool.RunData runData, org.sakaiproject.cheftool.Context context) Handles the user clicking on the save button on the page to specify which calendars will be merged into the present schedule.
void	doView(org.sakaiproject.cheftool.RunData data, org.sakaiproject.cheftool.Context context)
protected void	enableObserver(org.sakaiproject.event.api.SessionState sstate, boolean enable) Enable or disable the observer
static String	getCurrentOrder()
protected org.sakaiproject.cheftool.ControllerState	getState(org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, Class stateClass) Get the proper state for this instance (if portlet is not known, only context).
protected org.sakaiproject.cheftool.ControllerState	getState(String peid, org.sakaiproject.cheftool.RunData rundata, Class stateClass) Get the proper state for this instance (if portlet id is known).
protected org.sakaiproject.cheftool.ControllerState	getState(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.RunData rundata, Class stateClass) Get the proper state for this instance (if portlet is known).
String	getTemplate(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState sstate, AnnouncementActionState state, String value)
protected void	initState(org.sakaiproject.event.api.SessionState state, org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.JetspeedRunData rundata) Populate the state object, if needed.
protected boolean	notificationEnabled(AnnouncementActionState state) is notification enabled?
protected void	postOrSaveDraft(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context, boolean post) post or save draft of a message?
protected void	readAnnouncementForm(org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.cheftool.Context context, boolean checkForm) Read user inputs in announcement form
protected List	readResourcesPage(org.sakaiproject.event.api.SessionState state, int first, int last)
protected void	releaseState(org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata) Release the proper state for this instance (if portlet is not known, only context).
protected void	releaseState(String peid, org.sakaiproject.cheftool.RunData rundata) Release the proper state for this instance (if portlet id is known).
protected void	releaseState(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.RunData rundata) Release the proper state for this instance (if portlet is known).
protected int	sizeResources(org.sakaiproject.event.api.SessionState state)

Methods inherited from class org.sakaiproject.cheftool.PagedResourceActionII

addListPagingMenus, addRefreshMenus, addSearchMenus, addViewPagingMenus, cleanStatePaging, doAuto, doChange_pagesize, doList_first, doList_last, doList_next, doList_prev, doRefresh, doSearch_clear, doSearch, doView_next, doView_page, doView_prev, enableObserver, pagingInfoToContext, prepPage, resetPaging, totalPageNumber

Methods inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

actionDispatch, addAlert, addOptionsMenu, allowedToOptions, cancelOptions, clientWindowId, disableObservers, doGet, doReset, enableObservers, getContext, getDateFormatString, helperActionDispatch, initState, justDelivered, mainPanelUpdateId, panelMethodName, processAction, resetTool, saveOptions, scheduleFocusRefresh, schedulePeerFrameRefresh, scheduleTopRefresh, setVmCourier, setVmStdRef, switchPanel, titlePanelUpdateId, toolModeDispatch, updateState

Methods inherited from class org.sakaiproject.cheftool.ToolServlet

doPost, getAlert, getAlert, getMenu, getPid, getState, getToolMode, prepState, sendToHelper, setToolMode, startHelper, startHelper

Methods inherited from class org.sakaiproject.vm.VmServlet

getActionURL, getVmReference, includeVm, setVmReference

Methods inherited from class org.sakaiproject.vm.ComponentServlet

sendParentRedirect, service, setNoCacheHeaders

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

STATE_MESSAGE

public static final String STATE_MESSAGE

See Also:

Constant Field Values

STATE_MESSAGES

public static final String STATE_MESSAGES

See Also:

Constant Field Values

STATE_INITED

protected static final String STATE_INITED

See Also:

Constant Field Values

Constructor Detail

AnnouncementAction

public AnnouncementAction()

Method Detail

getCurrentOrder

public static String getCurrentOrder()

enableObserver

protected void enableObserver(org.sakaiproject.event.api.SessionState sstate,
                              boolean enable)

Enable or disable the observer

Parameters:

enable - if true, the observer is enabled, if false, it is disabled

buildMergeContext

public String buildMergeContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                org.sakaiproject.cheftool.Context context,
                                org.sakaiproject.cheftool.RunData runData,
                                AnnouncementActionState state,
                                org.sakaiproject.event.api.SessionState sstate)

Build the context for showing merged view

buildReorderContext

public String buildReorderContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                  org.sakaiproject.cheftool.Context context,
                                  org.sakaiproject.cheftool.RunData runData,
                                  AnnouncementActionState state,
                                  org.sakaiproject.event.api.SessionState sstate)

Build the context for showing merged view

buildMainPanelContext

public String buildMainPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                    org.sakaiproject.cheftool.Context context,
                                    org.sakaiproject.cheftool.RunData rundata,
                                    org.sakaiproject.event.api.SessionState sstate)

Default is to use when Portal starts up

buildSortedContext

public void buildSortedContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                               org.sakaiproject.cheftool.Context context,
                               org.sakaiproject.cheftool.RunData rundata,
                               org.sakaiproject.event.api.SessionState sstate)

getTemplate

public String getTemplate(org.sakaiproject.cheftool.VelocityPortlet portlet,
                          org.sakaiproject.cheftool.Context context,
                          org.sakaiproject.cheftool.RunData rundata,
                          org.sakaiproject.event.api.SessionState sstate,
                          AnnouncementActionState state,
                          String value)

buildOptionsPanelContext

public String buildOptionsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                       org.sakaiproject.cheftool.Context context,
                                       org.sakaiproject.cheftool.RunData runData,
                                       org.sakaiproject.event.api.SessionState state)

Setup for the options panel.

buildPreviewContext

protected String buildPreviewContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                     org.sakaiproject.cheftool.Context context,
                                     org.sakaiproject.cheftool.RunData rundata,
                                     AnnouncementActionState state)

Build the context for preview an attachment

buildReviseAnnouncementContext

protected String buildReviseAnnouncementContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                                org.sakaiproject.cheftool.Context context,
                                                org.sakaiproject.cheftool.RunData rundata,
                                                AnnouncementActionState state,
                                                org.sakaiproject.event.api.SessionState sstate)

Build the context for revising the announcement

buildShowMetadataContext

protected String buildShowMetadataContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                          org.sakaiproject.cheftool.Context context,
                                          org.sakaiproject.cheftool.RunData rundata,
                                          AnnouncementActionState state,
                                          org.sakaiproject.event.api.SessionState sstate)

Build the context for viewing announcement content

doNext_message

public void doNext_message(org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.cheftool.Context context)

Responding to the request of going to next message

doPrev_message

public void doPrev_message(org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.cheftool.Context context)

Responding to the request of going to previous message

doShowmetadata

public void doShowmetadata(org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.cheftool.Context context)

corresponding to chef_announcements doShowMetadata

Parameters:

itemId - The string used to record the announcement id

buildCancelContext

protected String buildCancelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                    org.sakaiproject.cheftool.Context context,
                                    org.sakaiproject.cheftool.RunData rundata,
                                    AnnouncementActionState state)

Build the context for cancelling the operation and going back to list view

buildDeleteAnnouncementContext

protected String buildDeleteAnnouncementContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                                org.sakaiproject.cheftool.Context context,
                                                org.sakaiproject.cheftool.RunData rundata,
                                                AnnouncementActionState state)

Build the context for asking for the delete confirmation

doNewannouncement

public void doNewannouncement(org.sakaiproject.cheftool.RunData rundata,
                              org.sakaiproject.cheftool.Context context)

Action is to use when doNewannouncement requested, corresponding to chef_announcements menu "New..."

doAnnouncement_form

public void doAnnouncement_form(org.sakaiproject.cheftool.RunData data,
                                org.sakaiproject.cheftool.Context context)

Dispatcher function for various actions on add/revise announcement page

readAnnouncementForm

protected void readAnnouncementForm(org.sakaiproject.cheftool.RunData rundata,
                                    org.sakaiproject.cheftool.Context context,
                                    boolean checkForm)

Read user inputs in announcement form

Parameters:

data -

checkForm - need to check form data or not

doPost

public void doPost(org.sakaiproject.cheftool.RunData rundata,
                   org.sakaiproject.cheftool.Context context)

Action is to use when doPost requested, corresponding to chef_announcements-revise or -preview "eventSubmit_doPost"

postOrSaveDraft

protected void postOrSaveDraft(org.sakaiproject.cheftool.RunData rundata,
                               org.sakaiproject.cheftool.Context context,
                               boolean post)

post or save draft of a message?

doPreviewrevise

public void doPreviewrevise(org.sakaiproject.cheftool.RunData rundata,
                            org.sakaiproject.cheftool.Context context)

Action is to use when doPreviewrevise requested from preview status corresponding to chef_announcements-preview "eventSubmit_doPreviewrevise"

doDelete

public void doDelete(org.sakaiproject.cheftool.RunData rundata,
                     org.sakaiproject.cheftool.Context context)

Action is to use when ddoDelete requested, to perform deletion corresponding to chef_announcements-delete "eventSubmit_doDelete"

doDeleteannouncement

public void doDeleteannouncement(org.sakaiproject.cheftool.RunData rundata,
                                 org.sakaiproject.cheftool.Context context)

Action is to use when doDeleteannouncement requested, corresponding to chef_announcements or chef_announcements-metadata menu "Delete"

doDelete_announcement_link

public void doDelete_announcement_link(org.sakaiproject.cheftool.RunData rundata,
                                       org.sakaiproject.cheftool.Context context)

Action is to use when doDelete_announcement_link requested, corresponding to chef_announcements the link of deleting announcement item

doReviseannouncement

public void doReviseannouncement(org.sakaiproject.cheftool.RunData rundata,
                                 org.sakaiproject.cheftool.Context context)

Action is to use when doReviseannouncement requested, corresponding to chef_announcements the link of any draft announcement item

doReviseannouncementfrommenu

public void doReviseannouncementfrommenu(org.sakaiproject.cheftool.RunData rundata,
                                         org.sakaiproject.cheftool.Context context)

Action is to use when doReviseannouncementfrommenu requested, corresponding to chef_announcements.vm and -metadata.vm menu "Revise"

doRevisepreview

public void doRevisepreview(org.sakaiproject.cheftool.RunData rundata,
                            org.sakaiproject.cheftool.Context context)

Action is to use when doRevisePreview requested, corresponding to chef_announcements-revise "eventSubmit_doRevisePreview" from revise view to preview view

doAttachments

public void doAttachments(org.sakaiproject.cheftool.RunData data,
                          org.sakaiproject.cheftool.Context context)

doCancel

public void doCancel(org.sakaiproject.cheftool.RunData rundata,
                     org.sakaiproject.cheftool.Context context)

Action is to use when doCancel requested, corresponding to chef_announcement "eventSubmit_doCancel"

doLinkcancel

public void doLinkcancel(org.sakaiproject.cheftool.RunData rundata,
                         org.sakaiproject.cheftool.Context context)

Action is to use when doLinkcancel requested, corresponding to chef_announcement "eventSubmit_doLinkcancel"

doSavedraft

public void doSavedraft(org.sakaiproject.cheftool.RunData rundata,
                        org.sakaiproject.cheftool.Context context)

Action is to use when doSavedraft requested, corresponding to chef_announcements-preview "eventSubmit_doSavedraft"

doSortbysubject

public void doSortbysubject(org.sakaiproject.cheftool.RunData rundata,
                            org.sakaiproject.cheftool.Context context)

Do sort by subject

doSortbyfrom

public void doSortbyfrom(org.sakaiproject.cheftool.RunData rundata,
                         org.sakaiproject.cheftool.Context context)

Do sort by from - the author

doSortbypublic

public void doSortbypublic(org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.cheftool.Context context)

Do sort by public

doSortbydate

public void doSortbydate(org.sakaiproject.cheftool.RunData rundata,
                         org.sakaiproject.cheftool.Context context)

Do sort by the date of the announcement.

doSortbymessage_order

public void doSortbymessage_order(org.sakaiproject.cheftool.RunData rundata,
                                  org.sakaiproject.cheftool.Context context)

doSortbyreleasedate

public void doSortbyreleasedate(org.sakaiproject.cheftool.RunData rundata,
                                org.sakaiproject.cheftool.Context context)

doSortbyretractdate

public void doSortbyretractdate(org.sakaiproject.cheftool.RunData rundata,
                                org.sakaiproject.cheftool.Context context)

doSortbychannel

public void doSortbychannel(org.sakaiproject.cheftool.RunData rundata,
                            org.sakaiproject.cheftool.Context context)

Do sort by the announcement channel name.

doSortbyfor

public void doSortbyfor(org.sakaiproject.cheftool.RunData rundata,
                        org.sakaiproject.cheftool.Context context)

Do sort by for - grouop/site/public

doSortbygrouptitle

public void doSortbygrouptitle(org.sakaiproject.cheftool.RunData rundata,
                               org.sakaiproject.cheftool.Context context)

Do sort by group title

doSortbygroupdescription

public void doSortbygroupdescription(org.sakaiproject.cheftool.RunData rundata,
                                     org.sakaiproject.cheftool.Context context)

Do sort by group description

initState

protected void initState(org.sakaiproject.event.api.SessionState state,
                         org.sakaiproject.cheftool.VelocityPortlet portlet,
                         org.sakaiproject.cheftool.JetspeedRunData rundata)

Populate the state object, if needed.

Overrides:

initState in class org.sakaiproject.cheftool.PagedResourceActionII

doPermissions

public void doPermissions(org.sakaiproject.cheftool.RunData data,
                          org.sakaiproject.cheftool.Context context)

Fire up the permissions editor

doMerge

public void doMerge(org.sakaiproject.cheftool.RunData runData,
                    org.sakaiproject.cheftool.Context context)

Handle the "Merge" button on the toolbar

doReorder

public void doReorder(org.sakaiproject.cheftool.RunData runData,
                      org.sakaiproject.cheftool.Context context)

Handle the "Reorder" button on the toolbar

doUpdate

public void doUpdate(org.sakaiproject.cheftool.RunData runData,
                     org.sakaiproject.cheftool.Context context)

Handles the user clicking on the save button on the page to specify which calendars will be merged into the present schedule.

doReorderUpdate

public void doReorderUpdate(org.sakaiproject.cheftool.RunData rundata,
                            org.sakaiproject.cheftool.Context context)

This handles the "doUpdate" if we're processing an update from the "reorder" page.

doOptionsUpdate

public void doOptionsUpdate(org.sakaiproject.cheftool.RunData runData,
                            org.sakaiproject.cheftool.Context context)

This handles the "doUpdate" if we're in a processing an update from the options page.

doOptions

public void doOptions(org.sakaiproject.cheftool.RunData runData,
                      org.sakaiproject.cheftool.Context context)

Overrides:

doOptions in class org.sakaiproject.cheftool.VelocityPortletPaneledAction

notificationEnabled

protected boolean notificationEnabled(AnnouncementActionState state)

is notification enabled?

readResourcesPage

protected List readResourcesPage(org.sakaiproject.event.api.SessionState state,
                                 int first,
                                 int last)

Specified by:

readResourcesPage in class org.sakaiproject.cheftool.PagedResourceActionII

sizeResources

protected int sizeResources(org.sakaiproject.event.api.SessionState state)

Specified by:

sizeResources in class org.sakaiproject.cheftool.PagedResourceActionII

doView

public void doView(org.sakaiproject.cheftool.RunData data,
                   org.sakaiproject.cheftool.Context context)

getState

protected org.sakaiproject.cheftool.ControllerState getState(org.sakaiproject.cheftool.Context context,
                                                             org.sakaiproject.cheftool.RunData rundata,
                                                             Class stateClass)

Get the proper state for this instance (if portlet is not known, only context).

Parameters:

context - The Template Context (it contains a reference to the portlet).

rundata - The Jetspeed (Turbine) rundata associated with the request.

stateClass - The Class of the ControllerState to find / create.

Returns:

The proper state object for this instance.

getState

protected org.sakaiproject.cheftool.ControllerState getState(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                                             org.sakaiproject.cheftool.RunData rundata,
                                                             Class stateClass)

Get the proper state for this instance (if portlet is known).

Parameters:

portlet - The portlet being rendered.

rundata - The Jetspeed (Turbine) rundata associated with the request.

stateClass - The Class of the ControllerState to find / create.

Returns:

The proper state object for this instance.

getState

protected org.sakaiproject.cheftool.ControllerState getState(String peid,
                                                             org.sakaiproject.cheftool.RunData rundata,
                                                             Class stateClass)

Get the proper state for this instance (if portlet id is known).

Parameters:

peid - The portlet id.

rundata - The Jetspeed (Turbine) rundata associated with the request.

stateClass - The Class of the ControllerState to find / create.

Returns:

The proper state object for this instance.

releaseState

protected void releaseState(org.sakaiproject.cheftool.Context context,
                            org.sakaiproject.cheftool.RunData rundata)

Release the proper state for this instance (if portlet is not known, only context).

Parameters:

context - The Template Context (it contains a reference to the portlet).

rundata - The Jetspeed (Turbine) rundata associated with the request.

releaseState

protected void releaseState(org.sakaiproject.cheftool.VelocityPortlet portlet,
                            org.sakaiproject.cheftool.RunData rundata)

Release the proper state for this instance (if portlet is known).

Parameters:

portlet - The portlet being rendered.

rundata - The Jetspeed (Turbine) rundata associated with the request.

releaseState

protected void releaseState(String peid,
                            org.sakaiproject.cheftool.RunData rundata)

Release the proper state for this instance (if portlet id is known).

Parameters:

peid - The portlet id being rendered.

rundata - The Jetspeed (Turbine) rundata associated with the request.