org.apache.jetspeed.layout.impl
Class GetFolderAction

java.lang.Object
  extended by org.apache.jetspeed.layout.impl.BasePortletAction
      extended by org.apache.jetspeed.layout.impl.BaseGetResourceAction
          extended by org.apache.jetspeed.layout.impl.GetFolderAction
All Implemented Interfaces:
AjaxAction, AjaxBuilder, Constants

public class GetFolderAction
extends BaseGetResourceAction
implements AjaxAction, AjaxBuilder, Constants

Retrieve a single page AJAX Parameters: folder = the path of the folder to retrieve information on

Version:
$Id: $
Author:
David Sean Taylor

Field Summary
protected  org.apache.commons.logging.Log log
           
 
Fields inherited from class org.apache.jetspeed.layout.impl.BasePortletAction
errorTemplate, pageManager, securityBehavior, template
 
Fields inherited from interface org.apache.jetspeed.layout.impl.Constants
ABS, ACTION, CARTESIAN, COL, CUSTOM_MENUS, DEFAULT_LAYOUT, DESKTOP_EXTENDED, DESKTOP_PAGE_DECORATIONS, DESKTOP_PORTLET_DECORATIONS, DESTINATION, DOWN, FILTER, FOLDER, FOLDERS, FORMAT, FRAGMENTID, FRAGMENTS, GUESTUSERS, HEIGHT, INCLUDE_MENU_DEFS, IPADDRESS, LAYOUT, LAYOUTID, LAYOUTS, LEFT, LINK, LINKS, MENU, MENU_CONTEXT, MENU_DEFINITIONS, MENU_LOCALE, MENU_NAME, METADATA, NEWCOL, NEWROW, OFFLINE, OLD_DESKTOP_EXTENDED, OLD_HEIGHT, OLD_PORTLET_MODE, OLD_WIDTH, OLD_WINDOW_STATE, OLD_X, OLD_Y, OLD_Z, OLDCOL, OLDROW, ONLINE, PAGE, PAGE_DECORATIONS, PAGE_QUALIFIED_CREATE_ON_EDIT, PAGES, PORTLET_DECORATIONS, PORTLET_MODE, PORTLETENTITY, PORTLETID, PORTLETS, PROFILED_PATH, REASON, RESOURCE_NAME, RIGHT, ROLES, ROW, SECURITY_DEFS, SECURITY_OWNER, SECURITY_REFS, SESSIONS, SHORT_TITLE, SIZES, SOURCE, STANDARD_MENUS, STATUS, TITLE, TYPE, UP, USER_IS_ANONYMOUS, USERINFO, USERNAME, USERS, WIDTH, WINDOW_STATE, X, Y, Z
 
Constructor Summary
GetFolderAction(java.lang.String template, java.lang.String errorTemplate, PageManager pageManager, PortletActionSecurityBehavior securityBehavior)
           
 
Method Summary
protected  Folder retrieveFolder(RequestContext requestContext)
           
 boolean run(RequestContext requestContext, java.util.Map resultMap)
          The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.
 
Methods inherited from class org.apache.jetspeed.layout.impl.BaseGetResourceAction
putSecurityInformation
 
Methods inherited from class org.apache.jetspeed.layout.impl.BasePortletAction
buildContext, buildErrorContext, checkAccess, createNewPageOnEdit, getActionParameter, getErrorTemplate, getFragmentIdFromLocation, getFragmentIdFromLocation, getNonNullActionParameter, getParentFragmentById, getTemplate, isCreateNewPageOnEditEnabled, isPageQualifiedForCreateNewPageOnEdit, runBatch
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.ajax.AjaxAction
checkAccess, runBatch
 
Methods inherited from interface org.apache.jetspeed.ajax.AjaxBuilder
buildContext, buildErrorContext, getErrorTemplate, getTemplate
 

Field Detail

log

protected org.apache.commons.logging.Log log
Constructor Detail

GetFolderAction

public GetFolderAction(java.lang.String template,
                       java.lang.String errorTemplate,
                       PageManager pageManager,
                       PortletActionSecurityBehavior securityBehavior)
Method Detail

run

public boolean run(RequestContext requestContext,
                   java.util.Map resultMap)
Description copied from interface: AjaxAction
The action should put any parameters or results it wants passed on to the builders in the resultMap This method runs an Ajax action.

Specified by:
run in interface AjaxAction
Parameters:
requestContext - The Jetspeed Request Context
resultMap - map of action parameters passed to the builder context
Returns:
success is true, failure is false

retrieveFolder

protected Folder retrieveFolder(RequestContext requestContext)
                         throws java.lang.Exception
Throws:
java.lang.Exception


Copyright © 1999-2010 Apache Software Foundation. All Rights Reserved.