com.plumtree.portalpages.browsing.myportal
Class SetPageControl

java.lang.Object
  extended by com.plumtree.portalpages.browsing.myportal.SetPageControl
All Implemented Interfaces:
IControl, IManagedObject, IMVCObject

public class SetPageControl
extends java.lang.Object
implements IControl

Handles the MyPage control flow

Author:
MichaelD

Field Summary
static int N_HOME_PAGE_ID
          Home Page ID constant
static java.lang.String STR_MVC_CLASS_NAME
          Class Name
static java.lang.String STR_PAGE_ID
          Page ID
 
Constructor Summary
SetPageControl()
          Constructor for SetPageControl.
 
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 space)
          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
Class Name

See Also:
Constant Field Values

STR_PAGE_ID

public static final java.lang.String STR_PAGE_ID
Page ID

See Also:
Constant Field Values

N_HOME_PAGE_ID

public static final int N_HOME_PAGE_ID
Home Page ID constant

See Also:
Constant Field Values
Constructor Detail

SetPageControl

public SetPageControl()
Constructor for SetPageControl.

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.
See Also:
com.plumtree.xpshared.activityspace.IControl#execute()

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();)
See Also:
IManagedObject.Create()

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.
See Also:
com.plumtree.xpshared.activityspace.IControl#getName()

Init

public void Init(IModel model,
                 AActivitySpace space)
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.xpshared.activityspace.IControl#Init(IModel, AActivitySpace)



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.