com.plumtree.portalpages.browsing.search.advanced
Class AdvancedSearchModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portalpages.browsing.search.advanced.AdvancedSearchModel

All Implemented Interfaces:

IAdvancedSearchModelRO, IFilterIteratorContainerRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class AdvancedSearchModel
extends EditorModel
implements IAdvancedSearchModelRO

Author:

CraigS

Field Summary

protected java.lang.String	_mode
static java.lang.String	HTML_SELECT_NUMRESULTS
static java.lang.String	STR_MVC_CLASS_NAME

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

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

AdvancedSearchModel()

Method Summary

boolean	CheckEditorAccessAndStart(XPHashtable _htFormData) Implements some actions to perform on start.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	Finish() Implement some code to execute when the user clicks on "Finish".
IPTFilter	GetFilter()
IFilterIteratorRO	GetFilterIterator() Returns the current filter iterator.
java.lang.String	GetMode()
protected java.lang.String	GetModelMode(XPHashtable formdata)
java.lang.String	GetName() Returns the Class name.
IPTSession	GetSession()
boolean	GetShowPotentialErrors() Whether to flag items that will cause errors if the search is submitted.
int	SavePage(java.lang.String pageName, XPHashtable formData) Calls the right save function according to the page name passed in argument.
void	SetShowPotentialErrors()

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

Cancel, CleanupAllData, CleanupTempData, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, DoTaskOnComeBackFromSubEditor, DoTaskOnStartEditor, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetRedirectAfterFinish, GetUserHasAccessToEditor, Init, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

HTML_SELECT_NUMRESULTS

public static final java.lang.String HTML_SELECT_NUMRESULTS

See Also:

Constant Field Values

_mode

protected java.lang.String _mode

Constructor Detail

AdvancedSearchModel

public AdvancedSearchModel()

Method Detail

GetFilter

public IPTFilter GetFilter()

Returns:

GetSession

public IPTSession GetSession()

Returns:

GetFilterIterator

public IFilterIteratorRO GetFilterIterator()

Returns the current filter iterator.

Specified by:

GetFilterIterator in interface IFilterIteratorContainerRO

Returns:

the current filter iterator

CheckEditorAccessAndStart

public boolean CheckEditorAccessAndStart(XPHashtable _htFormData)

Implements some actions to perform on start.

Specified by:

CheckEditorAccessAndStart in class EditorModel

Parameters:

_htFormData -

Returns:

boolean Is true if the current user has the rights to access this Editor.

Create

public java.lang.Object Create()

Description copied from class: EditorModel

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 EditorModel

Returns:

Finish

public void Finish()

Description copied from class: EditorModel

Implement some code to execute when the user clicks on "Finish".

Specified by:

Finish in interface IRepostModel

Specified by:

Finish in class EditorModel

GetName

public java.lang.String GetName()

Description copied from class: EditorModel

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

GetShowPotentialErrors

public boolean GetShowPotentialErrors()

Description copied from interface: IAdvancedSearchModelRO

Whether to flag items that will cause errors if the search is submitted. It's nice to not do this at first, so the user can assemble a search without being constantly pestered, then we turn on validation once the user first attempts to submit the search.

Specified by:

GetShowPotentialErrors in interface IAdvancedSearchModelRO

Returns:

SavePage

public int SavePage(java.lang.String pageName,
                    XPHashtable formData)

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

Specified by:

SavePage in interface IRepostModel

Specified by:

SavePage in class EditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

SetShowPotentialErrors

public void SetShowPotentialErrors()

GetModelMode

protected java.lang.String GetModelMode(XPHashtable formdata)

GetMode

public java.lang.String GetMode()

Specified by:

GetMode in interface IAdvancedSearchModelRO