org.apache.jetspeed.modules.actions.portlets
Class PsmlBrowseAction

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.jetspeed.modules.actions.portlets.PortletActionEvent
                  org.apache.jetspeed.modules.actions.portlets.PortletAction
                      org.apache.jetspeed.modules.actions.portlets.GenericMVCAction
                          org.apache.jetspeed.modules.actions.portlets.VelocityPortletAction
                              org.apache.jetspeed.modules.actions.portlets.PsmlBrowseAction

public class PsmlBrowseAction

extends VelocityPortletAction

This action enables to browse any of the psml info, for displaying available entries and information on these entries

Version:

$Id: PsmlBrowseAction.java,v 1.14 2004/02/23 02:56:58 jford Exp $

Author:

David Sean Taylor

Field Summary

protected static java.lang.String	CUSTOMIZE_TEMPLATE
protected static java.lang.String	FALSE
static java.lang.String	FILTER_REGEXP name of the parameter that holds the regexp flag
static java.lang.String	FILTER_TYPE name of the parameter that holds the filter type
static java.lang.String	FILTER_TYPE_GROUP value of the filter type parameter for searching by group
static java.lang.String	FILTER_TYPE_ROLE value of the filter type parameter for searching by role
static java.lang.String	FILTER_TYPE_USER value of the filter type parameter for searching by username
static java.lang.String	FILTER_VALUE name of the parameter that holds the filter value
protected static java.lang.String	PAGE_SIZE
protected static java.lang.String	PROFILE_ITERATOR
protected static java.lang.String	PSML_REFRESH_FLAG
protected static java.lang.String	TRUE

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

PsmlBrowseAction()

Method Summary

protected void	buildConfigureContext(VelocityPortlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData rundata) Subclasses should override this method if they wish to provide their own customization behavior.
protected void	buildNormalContext(VelocityPortlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData rundata) Subclasses must override this method to provide default behavior for the portlet action
void	doFilter(org.apache.turbine.util.RunData rundata, org.apache.velocity.context.Context context) This method is to enter filtering mode.
void	doRefresh(org.apache.turbine.util.RunData rundata, org.apache.velocity.context.Context context) This method is to refresh psml from disk or database.
void	doUpdate(org.apache.turbine.util.RunData rundata, org.apache.velocity.context.Context context) This method is called when the user configures any of the parameters.

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.VelocityPortletAction

buildConfigureContext, buildMaximizedContext, buildMaximizedContext, buildNormalContext

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.GenericMVCAction

checkAdministrativeAction, doPerform, getAttribute, getAttribute, getPortletInstance, perform, setAttribute

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletAction

doPerform, getContext, getPortlet, getTemplate, resetTemplate, setTemplate, setTemplate

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletActionEvent

executeEvents, fireEvent

Methods inherited from class org.apache.turbine.modules.ActionEvent

executeEvents, formatString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PSML_REFRESH_FLAG

protected static final java.lang.String PSML_REFRESH_FLAG

See Also:

Constant Field Values

TRUE

protected static final java.lang.String TRUE

See Also:

Constant Field Values

FALSE

protected static final java.lang.String FALSE

See Also:

Constant Field Values

PROFILE_ITERATOR

protected static final java.lang.String PROFILE_ITERATOR

See Also:

Constant Field Values

PAGE_SIZE

protected static final java.lang.String PAGE_SIZE

See Also:

Constant Field Values

CUSTOMIZE_TEMPLATE

protected static final java.lang.String CUSTOMIZE_TEMPLATE

See Also:

Constant Field Values

FILTER_VALUE

public static final java.lang.String FILTER_VALUE

name of the parameter that holds the filter value

See Also:

Constant Field Values

FILTER_REGEXP

public static final java.lang.String FILTER_REGEXP

name of the parameter that holds the regexp flag

See Also:

Constant Field Values

FILTER_TYPE

public static final java.lang.String FILTER_TYPE

name of the parameter that holds the filter type

See Also:

Constant Field Values

FILTER_TYPE_USER

public static final java.lang.String FILTER_TYPE_USER

value of the filter type parameter for searching by username

See Also:

Constant Field Values

FILTER_TYPE_ROLE

public static final java.lang.String FILTER_TYPE_ROLE

value of the filter type parameter for searching by role

See Also:

Constant Field Values

FILTER_TYPE_GROUP

public static final java.lang.String FILTER_TYPE_GROUP

value of the filter type parameter for searching by group

See Also:

Constant Field Values

Constructor Detail

PsmlBrowseAction

public PsmlBrowseAction()

Method Detail

buildConfigureContext

protected void buildConfigureContext(VelocityPortlet portlet,
                                     org.apache.velocity.context.Context context,
                                     org.apache.turbine.util.RunData rundata)

Subclasses should override this method if they wish to provide their own customization behavior. Default is to use Portal base customizer action

Overrides:

buildConfigureContext in class VelocityPortletAction

buildNormalContext

protected void buildNormalContext(VelocityPortlet portlet,
                                  org.apache.velocity.context.Context context,
                                  org.apache.turbine.util.RunData rundata)

Subclasses must override this method to provide default behavior for the portlet action

Specified by:

buildNormalContext in class VelocityPortletAction

doUpdate

public void doUpdate(org.apache.turbine.util.RunData rundata,
                     org.apache.velocity.context.Context context)

This method is called when the user configures any of the parameters.

Parameters:

context - The velocity context for this request.

doRefresh

public void doRefresh(org.apache.turbine.util.RunData rundata,
                      org.apache.velocity.context.Context context)

This method is to refresh psml from disk or database.

Parameters:

context - The velocity context for this request.

doFilter

public void doFilter(org.apache.turbine.util.RunData rundata,
                     org.apache.velocity.context.Context context)

This method is to enter filtering mode.

Parameters:

context - The velocity context for this request.