com.sssw.portal.api
Interface EbiActionHandler

public interface EbiActionHandler

Interface for handling the actions that are fired by the presentation manager based on URL query parameters.

Field Summary

static String	ACTION_CLEAR_MODE_PERSIST Clears the mode for the component-instance/user from the persist store
static String	ACTION_CLEAR_MODE_SESSION Clears the current components mode from the session
static String	ACTION_MINIMIZE The components state is set to minimized for the duration of the session or until changed.
static String	ACTION_REMOVE When this action is specified the component instance will be removed from the page.
static String	ACTION_RESTORE When this action is specified the component instance state for the current user will be set to normal.
static String	ACTION_SET_MODE_PERSIST Sets the current components mode to whatever value is specified by the s3-mode param.
static String	ACTION_SET_MODE_REQUEST Sets the current components mode to whateve value is specified by the s3-mode param.
static String	ACTION_SET_MODE_SESSION Sets the current components mode to whatever value is specified by the s3-mode param.

Method Summary

void	doAction(EbiPortalContext context, String actionName) Gets the info object for the layout info with the given ID.

Field Detail

ACTION_REMOVE

public static final String ACTION_REMOVE

When this action is specified the component instance will be removed from the page. The user's page, the componentID, and the instance name must also be passed on the URL.

Since:

v4.0

ACTION_RESTORE

public static final String ACTION_RESTORE

When this action is specified the component instance state for the current user will be set to normal. If no user is logged in then the state is stored on the session for this particular components. The componentID, and the instance name must also be passed on the URL.

Since:

v4.0

ACTION_MINIMIZE

public static final String ACTION_MINIMIZE

The components state is set to minimized for the duration of the session or until changed. If a user is logged in the state willa ctually be persisted indefinately.

Since:

v4.0

ACTION_SET_MODE_REQUEST

public static final String ACTION_SET_MODE_REQUEST

Sets the current components mode to whateve value is specified by the s3-mode param. The mode is only set at the request level and gos away at the end of each request.

Since:

v4.0

ACTION_SET_MODE_SESSION

public static final String ACTION_SET_MODE_SESSION

Sets the current components mode to whatever value is specified by the s3-mode param. The mode is is set in the session so that the mode is maintained until the session expires or the mode is changed.

Since:

v4.0

ACTION_SET_MODE_PERSIST

public static final String ACTION_SET_MODE_PERSIST

Sets the current components mode to whatever value is specified by the s3-mode param. The mode is is set in the user store so that the mode is persisted permenantly or the mode is changed.

Since:

v4.0

ACTION_CLEAR_MODE_PERSIST

public static final String ACTION_CLEAR_MODE_PERSIST

Clears the mode for the component-instance/user from the persist store

Since:

v4.0

ACTION_CLEAR_MODE_SESSION

public static final String ACTION_CLEAR_MODE_SESSION

Clears the current components mode from the session

Since:

v4.0

Method Detail

doAction

public void doAction(EbiPortalContext context,
                     String actionName)

Gets the info object for the layout info with the given ID.

Parameters:

context - A portal context.

actionName - The name of the action to be fired

Since:

v4.0