org.sakaiproject.tool.prefs
Class MembershipAction

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.prefs.MembershipAction
All Implemented Interfaces:
Serializable, Servlet, ServletConfig

public class MembershipAction
extends PagedResourceActionII

MembershipAction is a tool which displays Sites and lets the user join and un-join joinable Sites.

Version:
$Revision: 6391 $
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
MembershipAction()
           
 
Method Summary
 String buildJoinableContext(VelocityPortlet portlet, Context context, RunData runData, SessionState state)
          Setup for the options panel.
 String buildMainPanelContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
          build the context
 String buildUnjoinconfirmContext(VelocityPortlet portlet, Context context, RunData runData, SessionState state)
          Build context for confirmation screen
 void doGoto_joinable(RunData data)
          Handle the eventSubmit_doGoto_unJoinable command to shwo the list of site which are joinable.
 void doGoto_unjoinable(RunData data)
          Handle the eventSubmit_doGoto_unJoinable command to shwo the list of site which are unjoinable.
 void doGoto_unjoincancel(RunData data)
          cancel unjoin of site
 void doGoto_unjoinconfirm(RunData data)
          Navigate to confirmation screen
 void doGoto_unjoinyes(RunData data)
          process unjoin
 void doJoin(RunData data)
          Handle the eventSubmit_doJoin command to have the user join one or more sites.
 void doToggle_joinable_sort(RunData data)
          toggle the sort ascending vs decending property in joinable view
 void doToggle_sort(RunData data)
          toggle the sort ascending vs decending property in main view
 void doUnjoin(RunData data)
          Handle the eventSubmit_doUnjoin command to have the user un-join one or more groups.
protected  List readResourcesPage(SessionState state, int first, int last)
          Implement this to return a list of all the resources in this record range, with search and sorting applied.
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, initState, pagingInfoToContext, prepPage, resetPaging, totalPageNumber
 
Methods inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction
actionDispatch, addAlert, addOptionsMenu, cancelOptions, clientWindowId, disableObservers, doGet, doOptions, 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

MembershipAction

public MembershipAction()
Method Detail

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

readResourcesPage

protected List readResourcesPage(SessionState state,
                                 int first,
                                 int last)
Description copied from class: PagedResourceActionII
Implement this to return a list of all the resources in this record range, with search and sorting applied.

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

buildMainPanelContext

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


doGoto_unjoinconfirm

public void doGoto_unjoinconfirm(RunData data)
Navigate to confirmation screen


buildUnjoinconfirmContext

public String buildUnjoinconfirmContext(VelocityPortlet portlet,
                                        Context context,
                                        RunData runData,
                                        SessionState state)
Build context for confirmation screen

Parameters:
portlet -
context -
runData -
state -
Returns:

doGoto_unjoinyes

public void doGoto_unjoinyes(RunData data)
process unjoin

Parameters:
data -

doGoto_unjoincancel

public void doGoto_unjoincancel(RunData data)
cancel unjoin of site

Parameters:
data -

buildJoinableContext

public String buildJoinableContext(VelocityPortlet portlet,
                                   Context context,
                                   RunData runData,
                                   SessionState state)
Setup for the options panel.


doGoto_unjoinable

public void doGoto_unjoinable(RunData data)
Handle the eventSubmit_doGoto_unJoinable command to shwo the list of site which are unjoinable.


doGoto_joinable

public void doGoto_joinable(RunData data)
Handle the eventSubmit_doGoto_unJoinable command to shwo the list of site which are joinable.


doJoin

public void doJoin(RunData data)
Handle the eventSubmit_doJoin command to have the user join one or more sites.


doUnjoin

public void doUnjoin(RunData data)
Handle the eventSubmit_doUnjoin command to have the user un-join one or more groups.


doToggle_sort

public void doToggle_sort(RunData data)
toggle the sort ascending vs decending property in main view


doToggle_joinable_sort

public void doToggle_joinable_sort(RunData data)
toggle the sort ascending vs decending property in joinable view