org.sakaiproject.tool.admin
Class UsersAction

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

public class UsersAction
extends PagedResourceActionII

UsersAction is the Sakai users editor.

Version:
$Revision: 5970 $
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
UsersAction()
           
 
Method Summary
 String buildMainPanelContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
          build the context
 void doCancel_remove(RunData data, Context context)
          doCancel_remove called when "eventSubmit_doCancel_remove" is in the request parameters to cancel user removal
 void doCancel(RunData data, Context context)
          doCancel called when "eventSubmit_doCancel" is in the request parameters to cancel user edits
 void doEdit(RunData data, Context context)
          doEdit called when "eventSubmit_doEdit" is in the request parameters to edit a user
 void doModify(RunData data, Context context)
          doModify called when "eventSubmit_doModify" is in the request parameters to edit a user
 void doNew(RunData data, Context context)
          doNew called when "eventSubmit_doNew" is in the request parameters to add a new user
 void doRemove_confirmed(RunData data, Context context)
          doRemove_confirmed called when "eventSubmit_doRemove_confirmed" is in the request parameters to remove the user
 void doRemove(RunData data, Context context)
          doRemove called when "eventSubmit_doRemove" is in the request par ameters to confirm removal of the user
 void doSave(RunData data, Context context)
          doSave called when "eventSubmit_doSave" is in the request parameters to save user edits
protected  void initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)
          Populate the state object, if needed.
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, 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

UsersAction

public UsersAction()
Method Detail

readResourcesPage

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.

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)
Implement this to return the number of records that are currently selected.

Specified by:
sizeResources in class PagedResourceActionII

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


doNew

public void doNew(RunData data,
                  Context context)
doNew called when "eventSubmit_doNew" is in the request parameters to add a new user


doEdit

public void doEdit(RunData data,
                   Context context)
doEdit called when "eventSubmit_doEdit" is in the request parameters to edit a user


doModify

public void doModify(RunData data,
                     Context context)
doModify called when "eventSubmit_doModify" is in the request parameters to edit a user


doSave

public void doSave(RunData data,
                   Context context)
doSave called when "eventSubmit_doSave" is in the request parameters to save user edits


doCancel

public void doCancel(RunData data,
                     Context context)
doCancel called when "eventSubmit_doCancel" is in the request parameters to cancel user edits


doRemove

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


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 user


doCancel_remove

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