com.plumtree.uiinfrastructure.editor
Class EditorStartControl

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorStartControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

Direct Known Subclasses:

PortletInBundleSelectionEditorStartControl

public class EditorStartControl
extends java.lang.Object
implements IControl

This start control is called anytime an Editor is started. Start Control classes should extend this class.

Author:

Julie Fournier

Field Summary

static int	EDITOR_START_FLAG_CREATE JF- Editor type: Create mode
static int	EDITOR_START_FLAG_EDIT JF- Editor type: Edit mode
static int	EDITOR_START_FLAG_INVALID JF- Editor type: Invalid
static int	EDITOR_START_FLAG_MISC JF- Editor type: Other
AActivitySpace	m_asOwner JF- Associated Activity Space
protected XPHashtable	m_htFormData JF- Contains all the form params from the request.
protected EditorModel	m_model JF- Associated Model
static java.lang.String	QS_CLOSE_WINDOW_ON_DONE JF- Query String constants: Param to tell the framework to close the window on finish and cancel.
static java.lang.String	QS_DELETE_ON_CANCEL JF- Query String constants: Param to tell the Activity space to delete it if the user clicks on cancel.
static java.lang.String	QS_EDITOR_HIDE_LEFTNAV JF- Query String constants: Param to tell the Framework to hide the left navigation
static java.lang.String	QS_EDITOR_TYPE JF- Query String constants: Editor type
static java.lang.String	STR_MVC_CLASS_NAME Object Name for AS

Constructor Summary

EditorStartControl()

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) This code is called by the AS Servlet each time there is an Editor is started.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
java.lang.String	GetName() Returns the Class name.
void	Init(IModel model, AActivitySpace space) Inits the class with the associated model and activity space.

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

Object Name for AS

See Also:

Constant Field Values

QS_EDITOR_TYPE

public static final java.lang.String QS_EDITOR_TYPE

JF- Query String constants: Editor type

See Also:

Constant Field Values

QS_DELETE_ON_CANCEL

public static final java.lang.String QS_DELETE_ON_CANCEL

JF- Query String constants: Param to tell the Activity space to delete it if the user clicks on cancel.

See Also:

Constant Field Values

QS_CLOSE_WINDOW_ON_DONE

public static final java.lang.String QS_CLOSE_WINDOW_ON_DONE

JF- Query String constants: Param to tell the framework to close the window on finish and cancel.

See Also:

Constant Field Values

QS_EDITOR_HIDE_LEFTNAV

public static final java.lang.String QS_EDITOR_HIDE_LEFTNAV

JF- Query String constants: Param to tell the Framework to hide the left navigation

See Also:

Constant Field Values

EDITOR_START_FLAG_INVALID

public static final int EDITOR_START_FLAG_INVALID

JF- Editor type: Invalid

See Also:

Constant Field Values

EDITOR_START_FLAG_CREATE

public static final int EDITOR_START_FLAG_CREATE

JF- Editor type: Create mode

See Also:

Constant Field Values

EDITOR_START_FLAG_EDIT

public static final int EDITOR_START_FLAG_EDIT

JF- Editor type: Edit mode

See Also:

Constant Field Values

EDITOR_START_FLAG_MISC

public static final int EDITOR_START_FLAG_MISC

JF- Editor type: Other

See Also:

Constant Field Values

m_asOwner

public AActivitySpace m_asOwner

JF- Associated Activity Space

m_model

protected EditorModel m_model

JF- Associated Model

m_htFormData

protected XPHashtable m_htFormData

JF- Contains all the form params from the request.

Constructor Detail

EditorStartControl

public EditorStartControl()

Method Detail

CheckActionSecurityAndExecute

public Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

This code is called by the AS Servlet each time there is an Editor is started. It calls the startEditor method in the Model if a valid Editor Type was in the QS. If the Redirect object returned is not null, the Servlet will the page specified by the Redirect. If the Redirect is null, the Servlet will get the current page from the AS and display it.

Specified by:

CheckActionSecurityAndExecute in interface IControl

Returns:

Redirect

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

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Returns:

String

Init

public void Init(IModel model,
                 AActivitySpace space)

Inits the class with the associated model and activity space.

Specified by:

Init in interface IControl

Parameters:

model -

space -