org.apache.jetspeed.layout.impl
Class GetPortletsAction

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

public class GetPortletsAction
extends BasePortletAction
implements AjaxAction, AjaxBuilder, Constants, java.util.Comparator

Get Portlets retrieves the portlet list available to the current subject AJAX Parameters: filter = (optional)filter to lookup portlets using fulltext search

Version:
$Id: $
Author:
David Gurney, David Sean Taylor

Field Summary
protected static org.apache.commons.logging.Log log
           
static java.lang.String PORTLET_ICON
           
 
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
GetPortletsAction(java.lang.String template, java.lang.String errorTemplate)
           
GetPortletsAction(java.lang.String template, java.lang.String errorTemplate, PageManager pageManager, PortletRegistry registry, SearchEngine searchEngine, SecurityAccessController securityAccessController, PortletActionSecurityBehavior securityBehavior)
           
 
Method Summary
 int compare(java.lang.Object obj1, java.lang.Object obj2)
           
protected  PortletDefinitionComposite getPortletFromParsedObject(ParsedObject po)
           
 java.util.List retrievePortlets(RequestContext requestContext, java.lang.String filter)
           
 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.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
 
Methods inherited from interface java.util.Comparator
equals
 

Field Detail

log

protected static final org.apache.commons.logging.Log log

PORTLET_ICON

public static final java.lang.String PORTLET_ICON
See Also:
Constant Field Values
Constructor Detail

GetPortletsAction

public GetPortletsAction(java.lang.String template,
                         java.lang.String errorTemplate)

GetPortletsAction

public GetPortletsAction(java.lang.String template,
                         java.lang.String errorTemplate,
                         PageManager pageManager,
                         PortletRegistry registry,
                         SearchEngine searchEngine,
                         SecurityAccessController securityAccessController,
                         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

retrievePortlets

public java.util.List retrievePortlets(RequestContext requestContext,
                                       java.lang.String filter)

getPortletFromParsedObject

protected PortletDefinitionComposite getPortletFromParsedObject(ParsedObject po)

compare

public int compare(java.lang.Object obj1,
                   java.lang.Object obj2)
Specified by:
compare in interface java.util.Comparator


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