org.sakaiproject.tool.helper
Class PermissionsAction

java.lang.Object
  extended byorg.sakaiproject.tool.helper.PermissionsAction

public class PermissionsAction
extends Object

PermissionsAction is a helper Action that other tools can use to edit their permissions.

Version:
$Revision: 4742 $
Author:
University of Michigan, CHEF Software Development Team

Field Summary
static String MODE_MAIN
          Modes.
static String STATE_DESCRIPTION
          State attribute for the description of what's being edited - users should set before starting.
static String STATE_MODE
          State attributes for Permissions mode - when it is MODE_DONE the tool can process the results.
static String STATE_PREFIX
          State attribute for the lock/ability string prefix to be presented / edited - users should set before starting.
static String STATE_REALM_ID
          State attribute for the realm id - users should set before starting.
static String STATE_REALM_ROLES_ID
          State attribute for the realm id - users should set before starting.
 
Constructor Summary
PermissionsAction()
           
 
Method Summary
static String buildHelperContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
          build the context.
static void doCancel(RunData data)
          Handle the eventSubmit_doCancel command to abort the edits.
static void doSave(RunData data)
          Handle the eventSubmit_doSave command to save the edited permissions.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATE_MODE

public static final String STATE_MODE
State attributes for Permissions mode - when it is MODE_DONE the tool can process the results.

See Also:
Constant Field Values

STATE_REALM_ID

public static final String STATE_REALM_ID
State attribute for the realm id - users should set before starting.

See Also:
Constant Field Values

STATE_REALM_ROLES_ID

public static final String STATE_REALM_ROLES_ID
State attribute for the realm id - users should set before starting.

See Also:
Constant Field Values

STATE_DESCRIPTION

public static final String STATE_DESCRIPTION
State attribute for the description of what's being edited - users should set before starting.

See Also:
Constant Field Values

STATE_PREFIX

public static final String STATE_PREFIX
State attribute for the lock/ability string prefix to be presented / edited - users should set before starting.

See Also:
Constant Field Values

MODE_MAIN

public static final String MODE_MAIN
Modes.

See Also:
Constant Field Values
Constructor Detail

PermissionsAction

public PermissionsAction()
Method Detail

buildHelperContext

public static String buildHelperContext(VelocityPortlet portlet,
                                        Context context,
                                        RunData rundata,
                                        SessionState state)
build the context.

Returns:
The name of the template to use.

doSave

public static void doSave(RunData data)
Handle the eventSubmit_doSave command to save the edited permissions.


doCancel

public static void doCancel(RunData data)
Handle the eventSubmit_doCancel command to abort the edits.