com.plumtree.portalpages.admin.editors.xui
Class XUIHelperModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.portalpages.admin.editors.xui.XUIHelperModel

All Implemented Interfaces:

IXUIHelperModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class XUIHelperModel
extends EditorHelperModel
implements IXUIHelperModelRO

This is the Helper Model class for the XUI page.

Author:

Julie Fournier

Field Summary

static java.lang.String	STR_MVC_CLASS_NAME Class Name for the Activity Space.
static java.lang.String	XUI_INPUT_PREFIX Prefix for the XUI input param names.
static java.lang.String	XUI_INPUT_TYPE_BOOLEAN Boolean type of value of the input.
static java.lang.String	XUI_INPUT_TYPE_INT Integer type of value of the input.
static boolean	XUI_NOT_INITIALIZED XUI page not initialized.
static boolean	XUI_PAGE_VALID XUI page valid.

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel

m_asOwner

Constructor Summary

XUIHelperModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
IXPPropertyBag	GetFinalXUISettings() Finalizes and returns the property bag.
java.lang.String	GetHelpFileName(int _nXUIPageID) Returns the XUI page help page name.
java.lang.String	GetHTMLForXUIPage(int _nXUIPageID) Returns the HTML for the XUI page.
java.lang.String	GetName() Returns the Class name.
java.lang.String	GetPageInstructions(int _nXUIPageID) Returns the XUI page instructions.
java.lang.String	GetPageTitle(int _nXUIPageID) Returns the XUI page title.
void	InitializeXUIHelperModel(IXPPropertyBag _pbXUISettings, IService _xuiService) Inits the XUI helper model.
int	SaveSection(XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetServiceIndex(int _nIndex) If there are multiple XUI services for the editor, set the index for this model.

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorHelperModel

CleanupAllData, CleanupTempData, 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

Class Name for the Activity Space.

See Also:

Constant Field Values

XUI_INPUT_PREFIX

public static final java.lang.String XUI_INPUT_PREFIX

Prefix for the XUI input param names.

See Also:

Constant Field Values

XUI_INPUT_TYPE_INT

public static final java.lang.String XUI_INPUT_TYPE_INT

Integer type of value of the input.

See Also:

Constant Field Values

XUI_INPUT_TYPE_BOOLEAN

public static final java.lang.String XUI_INPUT_TYPE_BOOLEAN

Boolean type of value of the input.

See Also:

Constant Field Values

XUI_NOT_INITIALIZED

public static final boolean XUI_NOT_INITIALIZED

XUI page not initialized.

See Also:

Constant Field Values

XUI_PAGE_VALID

public static final boolean XUI_PAGE_VALID

XUI page valid.

See Also:

Constant Field Values

Constructor Detail

XUIHelperModel

public XUIHelperModel()

Method Detail

Create

public java.lang.Object Create()

Description copied from class: EditorHelperModel

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 EditorHelperModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

GetFinalXUISettings

public IXPPropertyBag GetFinalXUISettings()

Finalizes and returns the property bag. Needs to be called at the end of the wizard, before we store the property bag in the object.

Returns:

IXPPropertyBag

GetHTMLForXUIPage

public java.lang.String GetHTMLForXUIPage(int _nXUIPageID)

Returns the HTML for the XUI page.

Specified by:

GetHTMLForXUIPage in interface IXUIHelperModelRO

Parameters:

_nXUIPageID - ID of the page to return the HTML for.

Returns:

String

See Also:

com.plumtree.portalpages.admin.editors.xui.XUIHelperModel#GetHTMLForXUIPage()

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorHelperModel

Returns:

String

GetPageInstructions

public java.lang.String GetPageInstructions(int _nXUIPageID)

Returns the XUI page instructions.

Specified by:

GetPageInstructions in interface IXUIHelperModelRO

Parameters:

_nXUIPageID - ID of the page to return the instructions for.

Returns:

String

See Also:

com.plumtree.portalpages.admin.editors.xui.XUIHelperModel#GetPageInstructions()

GetPageTitle

public java.lang.String GetPageTitle(int _nXUIPageID)

Returns the XUI page title.

Specified by:

GetPageTitle in interface IXUIHelperModelRO

Parameters:

_nXUIPageID - ID of the page to return the title for.

Returns:

String

See Also:

com.plumtree.portalpages.admin.editors.xui.XUIHelperModel#GetPageTitle()

GetHelpFileName

public java.lang.String GetHelpFileName(int _nXUIPageID)

Returns the XUI page help page name.

Parameters:

_nXUIPageID - ID of the page to return the help for.

Returns:

String

InitializeXUIHelperModel

public void InitializeXUIHelperModel(IXPPropertyBag _pbXUISettings,
                                     IService _xuiService)

Inits the XUI helper model.

Parameters:

_pbXUISettings - PropertyBag to store the XUI settings

_xuiService - XUI Service on the remote server

SaveSection

public int SaveSection(XPHashtable _htFormData)

Calls the right save function according to the page name passed in argument.

Specified by:

SaveSection in class EditorHelperModel

Parameters:

_htFormData -

Returns:

int Page status for server side validation

SetServiceIndex

public void SetServiceIndex(int _nIndex)

If there are multiple XUI services for the editor, set the index for this model.

Parameters:

_nIndex -