com.plumtree.portaluiinfrastructure.tree
Class StartTreeControl

java.lang.Object
  com.plumtree.uiinfrastructure.tree.AStartTreeControl
      com.plumtree.portaluiinfrastructure.tree.StartTreeControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class StartTreeControl
extends AStartTreeControl

This control allows you to start either the Admin Tree or the Browsing Tree.

Author:

Don Hayler

Field Summary

static java.lang.String	ACCESS_LEVEL pass in the ACCESS_LEVEL (ADMIN, EDIT, or READ -- default is SELECT) of objects to display.
static java.lang.String	COMMUNITY_FOLDER_ID pass in the community folder ID for THISCOMMUNITY mode (
static java.lang.String	COMMUNITY_MODE pass in the community mode (
static java.lang.String	DIRECTORY_MODE pass in the directory mode
static java.lang.String	QUERY_FILTER add a query filter to a class ID.
static java.lang.String	ROOT_ID pass in the object ID for the IPTAdminFolder you wish to display
static java.lang.String	STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.uiinfrastructure.tree.AStartTreeControl

ACTIONSUBTITLE, ALLOW_EMPTY_SUBMISSION, CLASS_IDS_TO_DISPLAY, DISPLAYED_ITEMS, HELP_TOPIC, HIDDEN_ITEMS, m_asModel, m_asOwner, MULTI_SELECT, ONCLICK_CALL, PARENT_FORM_NAME, PARENT_FORM_SPACE_ID, PARENT_SUBMIT_CALL, SELECT_MODE, SELECT_OPTIONS, SELECTED_ITEMS, SHOW_ROOT, SUBMIT_MODE, TITLE

Constructor Summary

StartTreeControl()

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.

Methods inherited from class com.plumtree.uiinfrastructure.tree.AStartTreeControl

Init

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

ROOT_ID

public static final java.lang.String ROOT_ID

pass in the object ID for the IPTAdminFolder you wish to display

See Also:

Constant Field Values

ACCESS_LEVEL

public static final java.lang.String ACCESS_LEVEL

pass in the ACCESS_LEVEL (ADMIN, EDIT, or READ -- default is SELECT) of objects to display.

See Also:

IObjectTreeModel.SetAccessLevel(int), Constant Field Values

QUERY_FILTER

public static final java.lang.String QUERY_FILTER

add a query filter to a class ID. This should be in the form of "nClassID,nPropID,nVal1,nVal2,nVal3,etc". This will set up an IN query filter for the nValx's. There cannot be any 0s in this list.

See Also:

IObjectTreeModel.SetQueryFilter(int, int, int[]), Constant Field Values

COMMUNITY_MODE

public static final java.lang.String COMMUNITY_MODE

pass in the community mode (

See Also:

IObjectTreeModelRO), Constant Field Values

DIRECTORY_MODE

public static final java.lang.String DIRECTORY_MODE

pass in the directory mode

See Also:

Constant Field Values

COMMUNITY_FOLDER_ID

public static final java.lang.String COMMUNITY_FOLDER_ID

pass in the community folder ID for THISCOMMUNITY mode (

See Also:

IObjectTreeModelRO), Constant Field Values

Constructor Detail

StartTreeControl

public StartTreeControl()

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

Overrides:

CheckActionSecurityAndExecute in class AStartTreeControl

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.uiinfrastructure.activityspace.IControl#Execute()

Create

public java.lang.Object Create()

Description copied from class: AStartTreeControl

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

Specified by:

Create in interface IManagedObject

Specified by:

Create in class AStartTreeControl

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

Specified by:

GetName in class AStartTreeControl

Returns:

the name of the object.

See Also:

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