com.plumtree.uiinfrastructure.help
Class HelpControl

java.lang.Object
  com.plumtree.uiinfrastructure.help.HelpControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class HelpControl
extends java.lang.Object
implements IControl

Author:

donh This Control retrieves the help URL from the query string.

Field Summary

protected HelpFrameAS	m_asOwner
static java.lang.String	STR_HELP_TOPIC Query string argument of the help topic to display.
static java.lang.String	STR_MVC_CLASS_NAME MVC object name
static java.lang.String	STR_PREVIOUS_URL Query string argument of the previous URL.

Constructor Summary

HelpControl()

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
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.

Methods inherited from class java.lang.Object

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

MVC object name

See Also:

Constant Field Values

STR_HELP_TOPIC

public static final java.lang.String STR_HELP_TOPIC

Query string argument of the help topic to display.

See Also:

Constant Field Values

STR_PREVIOUS_URL

public static final java.lang.String STR_PREVIOUS_URL

Query string argument of the previous URL.

See Also:

Constant Field Values

m_asOwner

protected HelpFrameAS m_asOwner

Constructor Detail

HelpControl

public HelpControl()

Method Detail

CheckActionSecurityAndExecute

public 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.

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

GetName

public 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.

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

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();)