com.ibm.portal.state.accessors.action.engine.deleteportlet
Interface DeletePortletActionAccessorFactory

All Superinterfaces:

AccessorFactory

public interface DeletePortletActionAccessorFactory
extends AccessorFactory

Factory interface which provides methods to obtain controllers that allow to set a "Delete Portlet" action upon the given state holder or document model.
For instance the controllers may be used to create EngineURLs that trigger the "Delete Portlet" action. Just request a controller that operates on the state holder /document model that has been associated with the respective EngineURL. NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:

5.1

Method Summary

DeletePortletActionAccessorController	getDeletePortletActionController(javax.servlet.http.HttpServletRequest request, StateHolderController state) Returns a DeletePortletActionAccessorController which allows for including a "Delete Portlet" engine action into the state holder.
DeletePortletActionAccessorController	getDeletePortletActionController(Node action, DocumentController model) Returns a DeletePortletActionAccessorController which allows for including a "Delete Portlet" engine action into the state holder. This controller should be used in case that no servlet request is available, e.g.
DeletePortletActionAccessorController	getDeletePortletActionController(StateHolderController state) Returns a DeletePortletActionAccessorController which allows for including a "Delete Portlet" engine action into the given state holder. This controller should be used in case that no servlet request is available, e.g.

Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory

compact

Method Detail

getDeletePortletActionController

DeletePortletActionAccessorController getDeletePortletActionController(StateHolderController state)

Returns a DeletePortletActionAccessorController which allows for including a "Delete Portlet" engine action into the given state holder.
This controller should be used in case that no servlet request is available, e.g. when generating a URL from within an EJB. Otherwise a controller should be requested via getDeletePortletActionController(HttpServletRequest, StateHolderController).

Parameters:

state - Read-write interface to an untyped state document model. Must not be null.

Returns:

A DeletePortletActionAccessorController instance.

getDeletePortletActionController

DeletePortletActionAccessorController getDeletePortletActionController(javax.servlet.http.HttpServletRequest request,
                                                                       StateHolderController state)

Returns a DeletePortletActionAccessorController which allows for including a "Delete Portlet" engine action into the state holder.

Parameters:

request - The current servlet request. Must not be null.

state - Read-write interface to an untyped state document model. Must not be null.

Returns:

A DeletePortletActionAccessorController instance.

getDeletePortletActionController

DeletePortletActionAccessorController getDeletePortletActionController(Node action,
                                                                       DocumentController model)

Returns a DeletePortletActionAccessorController which allows for including a "Delete Portlet" engine action into the state holder.
This controller should be used in case that no servlet request is available, e.g. when generating a URL from within an EJB. Otherwise a controller should be requested via getDeletePortletActionController(HttpServletRequest, StateHolderController).

Parameters:

root - Node representing the "Delete Portlet" action element (must not be null).

model - The state document model which contains root.

Returns:

A DeletePortletActionAccessorController instance.