com.plumtree.portaluiinfrastructure.intrinsicportlets
Class IntrinsicPortletControl

java.lang.Object
  com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

Direct Known Subclasses:

JobHistoryPortletControl, SavedSearchPortletControl, SiteMapPortletControl, StandardFooterControl, StandardHeaderControl

public abstract class IntrinsicPortletControl
extends java.lang.Object
implements IControl

Controls process the events generated by users. This is an abstract intrinsic portlet control that handle repost actions.

Author:

josephc

Field Summary

protected AActivitySpace	m_asOwner Parent Activity Space
protected IModel	m_model Model

Constructor Summary

IntrinsicPortletControl()

Method Summary

abstract Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace.
abstract java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
abstract java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModel model, AActivitySpace parent) Initialize the control with the model it should use and it's parent AActivitySpace.
abstract void	PerformRepostAction(int _nAction, XPHashtable _htFormData) This method is a dispatcher.

Methods inherited from class java.lang.Object

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

Field Detail

m_asOwner

protected AActivitySpace m_asOwner

Parent Activity Space

m_model

protected IModel m_model

Model

Constructor Detail

IntrinsicPortletControl

public IntrinsicPortletControl()

Method Detail

CheckActionSecurityAndExecute

public abstract Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Description copied from interface: IControl

Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace. Returning null means that the user should return to the parent AActivitySpace's current page. This method is designed to check that the user has access to perform the actions with the given parameters. If the user does not, a redirect object which has had Redirect.SetRedirectToLogin(true) called on it. If the user is the Guest, this will bounce to the login page and back to the Redirect after the user has logged on. If the user is already logged on, they will be redirected to an error page. In general, the error redirect that is returned should contain all of the query string parameters that made up the URL that originally led to the control. Checking whether or not a particular user ever has any access to the space, page, and control should be done in IPTActivitySpace.CheckBasicAccess().

Specified by:

CheckActionSecurityAndExecute in interface IControl

Returns:

Redirect where to redirect to after the control is finished executing. This will go to the login page or an error page if Redirect.SetRedirectToLogin(true) has been called.

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IControl#Execute()

Create

public abstract java.lang.Object Create()

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Returns:

A new instance of the managed class (i.e. return new Foo();)

GetName

public abstract java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Returns:

the name of the object.

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IControl#GetName()

Init

public void Init(IModel model,
                 AActivitySpace parent)

Description copied from interface: IControl

Initialize the control with the model it should use and it's parent AActivitySpace. This method needs to be called before any other methods. This method also clears all internal data so the control can be used again without fear of mixing data.

Specified by:

Init in interface IControl

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IControl#Init(IModel, AActivitySpace)

PerformRepostAction

public abstract void PerformRepostAction(int _nAction,
                                         XPHashtable _htFormData)

This method is a dispatcher. For each repost action it should perform the right action.

Parameters:

_nAction - Action to perform

_htFormData - Hash table containing form data