com.plumtree.portalpages.browsing.portalsettings.search
Class SearchSettingsModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portalpages.browsing.portalsettings.search.SearchSettingsModel

All Implemented Interfaces:

ISearchSettingsModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class SearchSettingsModel
extends EditorModel
implements ISearchSettingsModelRO

Author:

CraigS, based on JulieF template

Field Summary

static int	RETURNED_CARDS
static int	RETURNED_COLLAB
static int	RETURNED_COMMUNITIES
static int	RETURNED_CONTENT
static int	RETURNED_FOLDERS
static int	RETURNED_OBJTYPE_ARRAY_SIZE
static int	RETURNED_PAGES
static int	RETURNED_PORTLETS
static int	RETURNED_USERS
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

SearchSettingsModel()

Method Summary

boolean	CheckEditorAccessAndStart(XPHashtable formData) 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.
protected void	DoAfterModifyDeleteSSPEI(java.lang.String[] aSavedSearches)
protected void	DoBeforeDeleteSSPEI(SavedSearchData ssd)
void	Finish() Implements code to execute when the user clicks on "Finish".
java.lang.String	GetName() Returns the Class name.
int	GetPageSize()
java.lang.String[][]	GetPossibleGroupBy()
java.lang.String	GetPreferredGroupBy()
Redirect	GetRedirectAfterFinish() Returns the Redirect object (this is were we need to go at the end of the Editor).
boolean[]	GetReturnedObjectTypes()
java.lang.Object[][]	GetSavedSearches()
java.lang.String[]	GetSpecificLanguagesReturned()
void	Init(AActivitySpace parent) Inits the Model with the Activity Space.
boolean	IsCollabInstalled()
boolean	IsRestrictedToDefaultLanguage()
int	SavePage(java.lang.String pageName, XPHashtable formData) Calls the right save function according to the page name passed in argument.

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

RETURNED_CARDS

public static final int RETURNED_CARDS

See Also:

Constant Field Values

RETURNED_FOLDERS

public static final int RETURNED_FOLDERS

See Also:

Constant Field Values

RETURNED_USERS

public static final int RETURNED_USERS

See Also:

Constant Field Values

RETURNED_COMMUNITIES

public static final int RETURNED_COMMUNITIES

See Also:

Constant Field Values

RETURNED_PORTLETS

public static final int RETURNED_PORTLETS

See Also:

Constant Field Values

RETURNED_COLLAB

public static final int RETURNED_COLLAB

See Also:

Constant Field Values

RETURNED_CONTENT

public static final int RETURNED_CONTENT

See Also:

Constant Field Values

RETURNED_PAGES

public static final int RETURNED_PAGES

See Also:

Constant Field Values

RETURNED_OBJTYPE_ARRAY_SIZE

public static final int RETURNED_OBJTYPE_ARRAY_SIZE

See Also:

Constant Field Values

Constructor Detail

SearchSettingsModel

public SearchSettingsModel()

Method Detail

CheckEditorAccessAndStart

public boolean CheckEditorAccessAndStart(XPHashtable formData)

Implements some actions to perform on start.

Specified by:

CheckEditorAccessAndStart in class EditorModel

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:

Init

public void Init(AActivitySpace parent)

Description copied from class: EditorModel

Inits the Model with the Activity Space.

Specified by:

Init in interface IModel

Overrides:

Init in class EditorModel

Parameters:

parent - the parent Activity Space

Finish

public void Finish()

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

GetPageSize

public int GetPageSize()

Specified by:

GetPageSize in interface ISearchSettingsModelRO

Returns:

GetReturnedObjectTypes

public boolean[] GetReturnedObjectTypes()

Specified by:

GetReturnedObjectTypes in interface ISearchSettingsModelRO

Returns:

GetPreferredGroupBy

public java.lang.String GetPreferredGroupBy()

GetPossibleGroupBy

public java.lang.String[][] GetPossibleGroupBy()

GetSavedSearches

public java.lang.Object[][] GetSavedSearches()

Specified by:

GetSavedSearches in interface ISearchSettingsModelRO

Returns:

GetSpecificLanguagesReturned

public java.lang.String[] GetSpecificLanguagesReturned()

Specified by:

GetSpecificLanguagesReturned in interface ISearchSettingsModelRO

Returns:

IsRestrictedToDefaultLanguage

public boolean IsRestrictedToDefaultLanguage()

Specified by:

IsRestrictedToDefaultLanguage in interface ISearchSettingsModelRO

Returns:

IsCollabInstalled

public boolean IsCollabInstalled()

Specified by:

IsCollabInstalled in interface ISearchSettingsModelRO

Returns:

true if Collaboration Server is installed on the local portal.

SavePage

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

Description copied from class: EditorModel

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:

pageName -

formData -

Returns:

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish()

Description copied from class: EditorModel

Returns the Redirect object (this is were we need to go at the end of the Editor). By default this is going to the previous AS (the one that opened this one). But Editors can override that method if they need to redirect somewhere else.

Specified by:

GetRedirectAfterFinish in interface IRepostModel

Overrides:

GetRedirectAfterFinish in class EditorModel

Returns:

Redirect

DoBeforeDeleteSSPEI

protected void DoBeforeDeleteSSPEI(SavedSearchData ssd)

DoAfterModifyDeleteSSPEI

protected void DoAfterModifyDeleteSSPEI(java.lang.String[] aSavedSearches)