com.plumtree.portalpages.browsing.objectselection
Class ObjectSelectionActionControl

java.lang.Object
  com.plumtree.portalpages.browsing.objectselection.ObjectSelectionActionControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class ObjectSelectionActionControl
extends java.lang.Object
implements IControl

This control is used to perform actions on the object selection model in cases where you don't want to repost the entire form (i.e. AJAX, etc...)

Field Summary

static java.lang.String	FIRST_ITEM_TO_DISPLAY Post to self to change pagination displayed item.
protected IObjectSelectionModel	m_model
static java.lang.String	SEARCH_MODE Post to self to switch to search mode.
static java.lang.String	STR_MVC_CLASS_NAME

Constructor Summary

ObjectSelectionActionControl()

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

See Also:

Constant Field Values

SEARCH_MODE

public static final java.lang.String SEARCH_MODE

Post to self to switch to search mode.

See Also:

Constant Field Values

FIRST_ITEM_TO_DISPLAY

public static final java.lang.String FIRST_ITEM_TO_DISPLAY

Post to self to change pagination displayed item.

See Also:

Constant Field Values

m_model

protected IObjectSelectionModel m_model

Constructor Detail

ObjectSelectionActionControl

public ObjectSelectionActionControl()

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

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