org.sakaiproject.tool.email
Class MailboxAction

java.lang.Object
  extended byjavax.servlet.GenericServlet
      extended byjavax.servlet.http.HttpServlet
          extended byorg.sakaiproject.vm.ComponentServlet
              extended byorg.sakaiproject.vm.VmServlet
                  extended byorg.sakaiproject.cheftool.VmServlet
                      extended byorg.sakaiproject.cheftool.ToolServlet
                          extended byorg.sakaiproject.cheftool.VelocityPortletPaneledAction
                              extended byorg.sakaiproject.cheftool.PagedResourceActionII
                                  extended byorg.sakaiproject.tool.email.MailboxAction
All Implemented Interfaces:
Serializable, Servlet, ServletConfig

public class MailboxAction
extends PagedResourceActionII

MailboxAction is a the Sakai mailbox tool.

Version:
$Revision: 5825 $
Author:
University of Michigan, Sakai Software Development Team
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction
VelocityPortletPaneledAction.MyLogger
 
Field Summary
 
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, LAYOUT_MAIN, Log, MODE_OPTIONS, STATE_ACTION, STATE_FLOAT, STATE_HELPER, STATE_MESSAGE, STATE_MODE, STATE_OBSERVER, STATE_OBSERVER2, STATE_PRESENCE_OBSERVER, STATE_TOOL
 
Fields inherited from class org.sakaiproject.cheftool.ToolServlet
ALERT_ATTR, ALERT_STATE_INITED, 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
MailboxAction()
           
 
Method Summary
 String buildMainPanelContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
          build the context for the main panel
 String buildOptionsPanelContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
          Setup for options.
 void doCancel(RunData data, Context context)
          doCancel called for form input tags type="submit" named="eventSubmit_doCancel" cancel the options process
 void doHide_headers(RunData runData, Context context)
          Handle a hide headers request.
 void doList(RunData runData, Context context)
          Handle a return-to-list-view request.
 void doOptions(RunData runData, Context context)
          Handle a request to set options.
 void doPermissions(RunData data, Context context)
          Fire up the permissions editor
 void doRemove_cancel(RunData data, Context context)
          doCancel_remove called when "eventSubmit_doCancel_remove" is in the request parameters to cancel group removal
 void doRemove_confirmed(RunData data, Context context)
          doRemove_confirmed called when "eventSubmit_doRemove_confirmed" is in the request parameters to remove the group
 void doRemove(RunData data, Context context)
          doRemove called when "eventSubmit_doRemove" is in the request parameters to confirm removal of the group
 void doSort_date(RunData runData, Context context)
          Handle a user request to change the sort to "date"
 void doSort_from(RunData runData, Context context)
          Handle a user request to change the sort to "from"
 void doSort_subject(RunData runData, Context context)
          Handle a user request to change the sort to "subject"
 void doUpdate(RunData data, Context context)
          doUpdate called for form input tags type="submit" named="eventSubmit_doUpdate" update/save from the options process
 void doView_headers(RunData runData, Context context)
          Handle a view headers request.
 void doView(RunData runData, Context context)
          Handle a user drill down request.
protected  void initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)
          Populate the state object, if needed.
protected  List readAllResources(SessionState state)
          Implement this to return alist of all the resources that there are to page.
protected  List readResourcesPage(SessionState state, int first, int last)
          paging
protected  int sizeResources(SessionState state)
          Implement this to return the number of records that are currently selected.
 
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, cancelOptions, clientWindowId, disableObservers, doGet, doReset, enableObservers, getContext, helperActionDispatch, initState, justDelivered, mainPanelUpdateId, processAction, resetTool, saveOptions, scheduleFocusRefresh, schedulePeerFrameRefresh, scheduleTopRefresh, setVmCourier, setVmStdRef, titlePanelUpdateId, toolModeDispatch, updateState
 
Methods inherited from class org.sakaiproject.cheftool.ToolServlet
doPost, getAlert, getAlert, getMenu, getPid, getState, getToolMode, prepState, setToolMode
 
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
 

Constructor Detail

MailboxAction

public MailboxAction()
Method Detail

readResourcesPage

protected List readResourcesPage(SessionState state,
                                 int first,
                                 int last)
paging

Specified by:
readResourcesPage in class PagedResourceActionII
Parameters:
first - The first record to include (1 based).
last - The last record to include (inclusive, 1 based).

sizeResources

protected int sizeResources(SessionState state)
Description copied from class: PagedResourceActionII
Implement this to return the number of records that are currently selected.

Specified by:
sizeResources in class PagedResourceActionII

readAllResources

protected List readAllResources(SessionState state)
Implement this to return alist of all the resources that there are to page. Sort them as appropriate.


initState

protected void initState(SessionState state,
                         VelocityPortlet portlet,
                         JetspeedRunData rundata)
Populate the state object, if needed.

Overrides:
initState in class PagedResourceActionII

buildMainPanelContext

public String buildMainPanelContext(VelocityPortlet portlet,
                                    Context context,
                                    RunData rundata,
                                    SessionState state)
build the context for the main panel

Returns:
(optional) template name for this panel

doView

public void doView(RunData runData,
                   Context context)
Handle a user drill down request.


doList

public void doList(RunData runData,
                   Context context)
Handle a return-to-list-view request.


doView_headers

public void doView_headers(RunData runData,
                           Context context)
Handle a view headers request.


doHide_headers

public void doHide_headers(RunData runData,
                           Context context)
Handle a hide headers request.


doSort_from

public void doSort_from(RunData runData,
                        Context context)
Handle a user request to change the sort to "from"


doSort_date

public void doSort_date(RunData runData,
                        Context context)
Handle a user request to change the sort to "date"


doSort_subject

public void doSort_subject(RunData runData,
                           Context context)
Handle a user request to change the sort to "subject"


doRemove

public void doRemove(RunData data,
                     Context context)
doRemove called when "eventSubmit_doRemove" is in the request parameters to confirm removal of the group


doRemove_confirmed

public void doRemove_confirmed(RunData data,
                               Context context)
doRemove_confirmed called when "eventSubmit_doRemove_confirmed" is in the request parameters to remove the group


doRemove_cancel

public void doRemove_cancel(RunData data,
                            Context context)
doCancel_remove called when "eventSubmit_doCancel_remove" is in the request parameters to cancel group removal


doOptions

public void doOptions(RunData runData,
                      Context context)
Handle a request to set options.

Overrides:
doOptions in class VelocityPortletPaneledAction

buildOptionsPanelContext

public String buildOptionsPanelContext(VelocityPortlet portlet,
                                       Context context,
                                       RunData rundata,
                                       SessionState state)
Setup for options.


doUpdate

public void doUpdate(RunData data,
                     Context context)
doUpdate called for form input tags type="submit" named="eventSubmit_doUpdate" update/save from the options process


doCancel

public void doCancel(RunData data,
                     Context context)
doCancel called for form input tags type="submit" named="eventSubmit_doCancel" cancel the options process


doPermissions

public void doPermissions(RunData data,
                          Context context)
Fire up the permissions editor