com.plumtree.portalpages.browsing.objectselection
Class ObjectSelectionModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portalpages.browsing.objectselection.ObjectSelectionModel

All Implemented Interfaces:

IObjectSelectionModel, IObjectSelectionModelRO, IFolderModel, IFolderModelRO, IObjectModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

Direct Known Subclasses:

PortletInBundleObjectSelectionModel

public class ObjectSelectionModel
extends EditorModel
implements IEditorModelRO, IFolderModel, IFolderModelRO, IObjectSelectionModel, IObjectSelectionModelRO

Author:

michaeld

Field Summary

static int	COL_OBJECT_ID Column for selected object's id
static int	COL_OBJECT_INFO Column for selected object's info
static int	COL_OBJECT_MAX Column count for selected object
static int	COL_SELECTED_NAME Column for Selected info item's name
static int	DEFAULT_OBJECTS_FOR_SEARCH_COLUMN_RESULTS Default number of objects that can be displayed in the search results if the number of search columns is specified.
static java.lang.String	DIRTY Dirty dictionary
static java.lang.String	HTMLINPUT_HIDDEN_ALIGNMENT HTML Input Hidden Alignment
static java.lang.String	HTMLINPUT_HIDDEN_ID HTML Input Hidden Object ID
static java.lang.String	HTMLINPUT_HIDDEN_NAME HTML Input Hidden Name
IFolderViewHelper	m_folderViewHelper Stores common class used to display one folder
protected int	m_nFirstDisplayableItem
protected int	m_nNumberOfItemsPerPage
protected SearchSettingCollection	m_ssc Search Setting Collection
static int	MAX_OBJECTS_FOR_FLAT_VIEW Default maximum objects that can be displayed in a flat selection view.
static java.lang.String	STR_MVC_CLASS_NAME Object Name

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

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

Constructor Summary

ObjectSelectionModel()

Method Summary

void	AddNewlySelected(java.lang.String _strObjectID, java.lang.String _strAlignment, java.lang.String _strName) Adds a newly selected object to the list so that the objects can be added permanently when the user clicks on finish.
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.
boolean	DoNotShowObject(int nIndex) Get whether to show this object or not.
boolean	DoNotShowObjectWithID(int nObjectID) Get whether or not to show an object given the objectID
void	DoTaskOnComeBackFromSubEditor() This method will be called when you come back to the main Editor from a sub Editor.
void	Finish() Implement some code to execute when the user clicks on "Finish".
AActivitySpace	GetActivitySpace() Get the activity space.
IASQueryResult	GetBreadCrumbPath() This method returns a 2d query result with folder level, id, and name.
int	GetCurrentFolderID() Get the id of the current folder.
int	GetCurrentFolderLevel() Get the level of the current folder
java.lang.String	GetCurrentFolderName() Get the name of the current folder.
int	GetCurrentLowerObjectIndex()
int	GetCurrentUpperObjectIndex()
boolean	GetDisplayPaginationHiddenInputs() Get whether or not to display the hidden inputs needed by the PaginationControl.
boolean	GetDisplaySearch() Returns true if we need to display the search results view.
boolean	GetDisplaySortHiddenInputs() Get whether or not to display the hidden inputs needed by the SortControl.
int	GetFirstDisplayableItem() Get the first displayable item for pagination in the object selection model if pagination is used.
int	GetFirstFolderIndex() Get the index of the first folder to display.
int	GetFolderColumnCount() Get the number of columns to display.
IASQueryResult	GetFolderObjectCount() Get a list of object names and the number of those objects in the current folder.
IASQueryResult	GetFolderQueryResult() Get an IPTQueryResult containing all of the subfolders of the current folder.
IFolderViewHelper	GetFolderViewHelper() Retrieves common class used to display one folder
int	GetHeaderCount() Gets the count of the object headers.
boolean	GetHeaderHasCheckbox() Returns whether the header has a checkbox or not.
HTMLTableRow	GetHeaderRow() Returns the header row
java.lang.String	GetHeaderText(int nHeaderIndex) Gets the text of the header at the given index.
java.lang.String	GetInputValue(java.lang.String strInput) Returns the value of the given input.
boolean	GetIsCollapsable() Gets whether or not the object banner should be collapsable.
boolean	GetIsFolderSelected(int nFolderID) This method returns whether or not the requested folder is currently selected.
boolean	GetIsObjectSelected(int nObjectID) This method returns whether or not the requested object ID is currently selected.
int	GetItemsPerPage() Get the number of items per page for pagination in the object selection model if pagination is used.
int	GetLastFolderIndex() Get the index of the first folder to display.
boolean	GetMultipleSelect() Get wether we can select multiple or single.
java.lang.String	GetName() Returns the Class name.
int	GetNumObjects()
int	GetNumSubSubFolders()
int	GetNumSubSubFoldersToDisplay() Set the number of sub-subfolders to display after the next page..
java.lang.String	GetObjectBannerTitle() Gets the name of the current folder.
int	GetObjectColumnCount() Gets the number of columns of objects
int	GetObjectCount() Gets the count of the objects in the query result.
java.lang.Object	GetObjectFields(int nIndex, int ptPropID) Gets the fields from the query result.
int	GetObjectSubType(int nIndex) Get the subtype of the object at the given index.
int	GetObjectType() Get the Object Class ID of the type of objects we are currently viewing.
boolean	GetObjectViewIsCollapsed() Get whether the object view is collapsed.
int	GetParentFolderID() Get the ID of the parent folder of the current folder.
java.lang.Object[]	GetParentFolderIDs() Get an Object array containing the Integer IDs of all the parent folders (the path) of the current folder.
java.lang.String	GetParentFormName() Get the name of the parent window's form.
java.lang.String	GetParentFormSelectedItems() Get the name of the form element for selected items.
java.lang.String	GetParentFormSpaceID() Get the string that is the parent form space ID.
java.lang.String	GetParentFormSubmitFunction() Get the string that is the parent form submit function.
java.lang.String	GetPath() Get the path to the current folder concatenated with '\'.
IPTSession	GetPTSession() Get the session
Redirect	GetRedirectAfterFinish() Returns the Obj Manager Redirect object (this is were we need to go at the end of the Editor).
XPSortedDictionary	GetRemovedObjectsForParent() Gets the selected objects from this object selector.
SearchSettingCollection	GetSearchSettingCollection() Returns the Search Setting Collection.
boolean	GetSearchStarted() Returns true if a search has been initialized.
java.lang.String	GetSelectedNamesAsString() Get the selected names as a string.
XPSortedDictionary	GetSelectedObjectsForParent() Gets the selected objects from this object selector.
IObjectSelectionModelHelper	GetSelectionModelHelper()
int	GetSelectorClassID() Get the selector's class ID.
int	GetSelectorCommunityFolderID() Get the selector's community folder ID.
int	GetSelectorCommunityID() Get the selector's community ID.
int	GetSelectorObjectID() Get the selector's object ID.
int	GetSelectorPageID() Get the selector's page ID.
boolean	GetShowCheckbox() Returns whether the folders should have checkboxes next to them.
boolean	GetShowEditIcon()
boolean	GetShowFolderBanner() Returns whether the subfolder banner should be shown.
boolean	GetShowPagination() Get whether these objects should use pagination or not.
boolean	GetSortable() Get whether these objects are sortable or not.
int	GetSortDirection()
int	GetSortedHeader()
int	GetSortPropertyId() Gets the current property id that the model is ordered by.
java.lang.String	GetSpaceID() Get the SpaceID of the parent Activity Space
int	GetSubFolderCount() Get the number of folders at all levels in the hierachy
int	GetSubFolderCount(int nFolderLevel) Get the number of sub folders in the current folder at the specified level.
XPArrayList	GetSubSubFolderInfo(int nSubFolderIndex, int nInfoType)
int	GetTemporaryInvitationID() Temporary value, filled in by invitation controls, that gives the ID of the object to the invitation view.
java.lang.String	GetTemporaryInvitationName() Temporary value, filled in by invitation controls, that gives the name of the object to the invitation view.
int	GetTotalItems() Get the total number of items for pagination in the object selection model if pagination is used.
protected void	InitializeSearchSettingCollection() Sets up the initial configuration of the search for portlets or comunities.
boolean	InRootFolder() Returns true if the current folder is the root folder.
boolean	IsCommunityPage()
boolean	IsHomeMyPage()
boolean	IsMyPage()
boolean	IsPageTemplate()
void	OpenSubFolder(int _nFolderID) Open the folder with the id ID.
void	RefreshObjectSelection() Method RefreshObjectSelection.
void	RefreshSelectedObjects() Method RefreshSelectedObjects.
void	RemoveObject(java.lang.String _strObjectID) Removes an object from the newselected list so that it will not get added when the user clicks on finish.
void	RepostAddObject()
void	RepostAddPortletsFromBundle() Method RepostAddPortletsFromBundle.
void	RepostOpenFolder() Method RepostOpenFolder.
void	RepostRemoveObject()
void	RepostSelectPortletBundle() Method RepostSelectPortletBundle.
void	RepostToSearch() Modifies the object name on repost.
protected void	SaveMainPage(XPHashtable _htFormData) Saves the data on the Main page.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetDisplaySearch(boolean _bDisplaySearch) This method is used by the portlet flyout control to switch from browse mode to search mode.
void	SetFirstDisplayableItem(int _nFirstItem) Set the first displayable item for pagination in the object selection model if pagination is used.
void	SetFirstItemIndex(int nFirstItemIndex) Set the index of the first folder to display on a page.
void	SetHost(java.lang.String strHost)
void	SetItemsPerPage(int _nItemsPerPage) Set the number of items per page for pagination in the object selection model if pagination is used.
void	SetLastItemIndex(int nLastItemIndex) Set the index of the first folder to display on a page.
void	SetNeverFlatView(boolean bNeverFlatView)
void	SetNumSubSubFolders(int nSubSubFolders)
void	SetObjectViewIndex(int nObjectViewIndex) Sets the index of the object view the page is currently displaying.
void	SetSelectionModelHelper(IObjectSelectionModelHelper selectionModelHelper) Sets the Selection Model Helper for the Selection Model to use.
void	SetShowFolderBanner(boolean bShowBanner)
void	SetSortPropertyId(int sortPropertyId)
void	SetTemporaryInvitationID(int nTemporaryInvitationID) Temporary value, filled in by invitation controls, that gives the ID of the object to the invitation view.
void	SetTemporaryInvitationName(java.lang.String strTemporaryInvitationName) Temporary value, filled in by invitation controls, that gives the name of the object to the invitation view.
boolean	ShowObjectBanner() Get whether to show the banner or not.

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

Cancel, CleanupAllData, CleanupTempData, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, DoTaskOnStartEditor, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetHideLeftNav, GetIsEditorReadOnly, 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, GetHideLeftNav, GetIsEditorReadOnly

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel

CleanupAllData, CleanupTempData, Init

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Object Name

See Also:

Constant Field Values

DIRTY

public static final java.lang.String DIRTY

Dirty dictionary

See Also:

Constant Field Values

HTMLINPUT_HIDDEN_NAME

public static final java.lang.String HTMLINPUT_HIDDEN_NAME

HTML Input Hidden Name

See Also:

Constant Field Values

HTMLINPUT_HIDDEN_ALIGNMENT

public static final java.lang.String HTMLINPUT_HIDDEN_ALIGNMENT

HTML Input Hidden Alignment

See Also:

Constant Field Values

HTMLINPUT_HIDDEN_ID

public static final java.lang.String HTMLINPUT_HIDDEN_ID

HTML Input Hidden Object ID

See Also:

Constant Field Values

MAX_OBJECTS_FOR_FLAT_VIEW

public static final int MAX_OBJECTS_FOR_FLAT_VIEW

Default maximum objects that can be displayed in a flat selection view.

See Also:

Constant Field Values

DEFAULT_OBJECTS_FOR_SEARCH_COLUMN_RESULTS

public static final int DEFAULT_OBJECTS_FOR_SEARCH_COLUMN_RESULTS

Default number of objects that can be displayed in the search results if the number of search columns is specified.

See Also:

Constant Field Values

COL_SELECTED_NAME

public static final int COL_SELECTED_NAME

Column for Selected info item's name

See Also:

Constant Field Values

COL_OBJECT_MAX

public static final int COL_OBJECT_MAX

Column count for selected object

See Also:

Constant Field Values

COL_OBJECT_ID

public static final int COL_OBJECT_ID

Column for selected object's id

See Also:

Constant Field Values

COL_OBJECT_INFO

public static final int COL_OBJECT_INFO

Column for selected object's info

See Also:

Constant Field Values

m_folderViewHelper

public IFolderViewHelper m_folderViewHelper

Stores common class used to display one folder

m_ssc

protected SearchSettingCollection m_ssc

Search Setting Collection

m_nFirstDisplayableItem

protected int m_nFirstDisplayableItem

m_nNumberOfItemsPerPage

protected int m_nNumberOfItemsPerPage

Constructor Detail

ObjectSelectionModel

public ObjectSelectionModel()

Method Detail

CheckEditorAccessAndStart

public boolean CheckEditorAccessAndStart(XPHashtable _htFormData)

Implements some actions to perform on start.

Specified by:

CheckEditorAccessAndStart in interface IObjectSelectionModelRO

Specified by:

CheckEditorAccessAndStart in class EditorModel

Parameters:

_htFormData - Request data

Returns:

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

RefreshObjectSelection

public void RefreshObjectSelection()

Method RefreshObjectSelection.

RefreshSelectedObjects

public void RefreshSelectedObjects()

Method RefreshSelectedObjects. Refreshes the selected objects.

Specified by:

RefreshSelectedObjects in interface IObjectSelectionModel

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:

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

See Also:

IManagedObject.Create()

DoNotShowObject

public boolean DoNotShowObject(int nIndex)

Description copied from interface: IObjectModelRO

Get whether to show this object or not.

Specified by:

DoNotShowObject in interface IObjectModelRO

Returns:

boolean true implies object is hidden, false implies show object

See Also:

IObjectModelRO.DoNotShowObject(int)

DoNotShowObjectWithID

public boolean DoNotShowObjectWithID(int nObjectID)

Description copied from interface: IObjectSelectionModelRO

Get whether or not to show an object given the objectID

Specified by:

DoNotShowObjectWithID in interface IObjectSelectionModelRO

Returns:

boolean

See Also:

IObjectSelectionModelRO.DoNotShowObjectWithID(int)

DoTaskOnComeBackFromSubEditor

public void DoTaskOnComeBackFromSubEditor()

Description copied from class: EditorModel

This method will be called when you come back to the main Editor from a sub Editor.

Overrides:

DoTaskOnComeBackFromSubEditor in class EditorModel

See Also:

This method will be called when you come back to the main Editor from a sub Editor.

Finish

public void Finish()

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

Specified by:

Finish in interface IRepostModel

Specified by:

Finish in class EditorModel

GetActivitySpace

public AActivitySpace GetActivitySpace()

Get the activity space.

Returns:

AActivitySpace space

GetCurrentFolderID

public int GetCurrentFolderID()

Description copied from interface: IFolderModelRO

Get the id of the current folder.

Specified by:

GetCurrentFolderID in interface IFolderModelRO

See Also:

IFolderModelRO.GetCurrentFolderID()

GetCurrentFolderLevel

public int GetCurrentFolderLevel()

Description copied from interface: IFolderModelRO

Get the level of the current folder

Specified by:

GetCurrentFolderLevel in interface IFolderModelRO

See Also:

IFolderModelRO.GetCurrentFolderLevel()

GetCurrentFolderName

public java.lang.String GetCurrentFolderName()

Description copied from interface: IFolderModelRO

Get the name of the current folder.

Specified by:

GetCurrentFolderName in interface IFolderModelRO

See Also:

IFolderModelRO.GetCurrentFolderName()

GetCurrentLowerObjectIndex

public int GetCurrentLowerObjectIndex()

See Also:

com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentLowerObjectIndex()

GetCurrentUpperObjectIndex

public int GetCurrentUpperObjectIndex()

See Also:

com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentUpperObjectIndex()

GetDisplayPaginationHiddenInputs

public boolean GetDisplayPaginationHiddenInputs()

Description copied from interface: IObjectModelRO

Get whether or not to display the hidden inputs needed by the PaginationControl. This is only useful if GetShowPagination() returns true.

Specified by:

GetDisplayPaginationHiddenInputs in interface IObjectModelRO

Returns:

boolean true implies display hidden inputs

See Also:

IObjectModelRO.GetDisplayPaginationHiddenInputs()

GetDisplaySearch

public boolean GetDisplaySearch()

Description copied from interface: IObjectSelectionModelRO

Returns true if we need to display the search results view.

Specified by:

GetDisplaySearch in interface IObjectSelectionModelRO

Returns:

boolean

See Also:

IObjectSelectionModelRO.GetDisplaySearch()

GetDisplaySortHiddenInputs

public boolean GetDisplaySortHiddenInputs()

Description copied from interface: IObjectModelRO

Get whether or not to display the hidden inputs needed by the SortControl. This is only useful if GetSortable() returns true.

Specified by:

GetDisplaySortHiddenInputs in interface IObjectModelRO

Returns:

boolean true implies display hidden inputs

See Also:

IObjectModelRO.GetDisplaySortHiddenInputs()

GetFirstFolderIndex

public int GetFirstFolderIndex()

Description copied from interface: IFolderModelRO

Get the index of the first folder to display.

Specified by:

GetFirstFolderIndex in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetFirstItemIndex()

GetFolderColumnCount

public int GetFolderColumnCount()

Description copied from interface: IFolderModelRO

Get the number of columns to display.

Specified by:

GetFolderColumnCount in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetNumColumns()

GetFolderObjectCount

public IASQueryResult GetFolderObjectCount()

Description copied from interface: IFolderModelRO

Get a list of object names and the number of those objects in the current folder. The list will have PT_PROPID_CLASSID ("filter 32") and PT_PROPID_OBJECTCOUNT (12).

Specified by:

GetFolderObjectCount in interface IFolderModelRO

See Also:

IFolderModelRO.GetFolderObjectCount()

GetFolderQueryResult

public IASQueryResult GetFolderQueryResult()

Description copied from interface: IFolderModelRO

Get an IPTQueryResult containing all of the subfolders of the current folder.

Specified by:

GetFolderQueryResult in interface IFolderModelRO

See Also:

IFolderModelRO.GetFolderQueryResult()

GetFolderViewHelper

public IFolderViewHelper GetFolderViewHelper()

Retrieves common class used to display one folder

Specified by:

GetFolderViewHelper in interface IFolderModelRO

Returns:

GetHeaderCount

public int GetHeaderCount()

Description copied from interface: IObjectModelRO

Gets the count of the object headers. Returns 0 if the array is null.

Specified by:

GetHeaderCount in interface IObjectModelRO

Returns:

int nHeaderCount

See Also:

IObjectModelRO.GetHeaderCount()

GetHeaderHasCheckbox

public boolean GetHeaderHasCheckbox()

Description copied from interface: IObjectModelRO

Returns whether the header has a checkbox or not.

Specified by:

GetHeaderHasCheckbox in interface IObjectModelRO

Returns:

boolean

See Also:

IObjectModelRO.GetHeaderHasCheckbox()

GetHeaderRow

public HTMLTableRow GetHeaderRow()

Description copied from interface: IObjectModelRO

Returns the header row

Specified by:

GetHeaderRow in interface IObjectModelRO

Returns:

int nHeaderCount

See Also:

IObjectModelRO.GetHeaderRow()

GetHeaderText

public java.lang.String GetHeaderText(int nHeaderIndex)

Description copied from interface: IObjectModelRO

Gets the text of the header at the given index.

Specified by:

GetHeaderText in interface IObjectModelRO

Parameters:

nHeaderIndex - nHeaderIndex

Returns:

String strHeaderText

See Also:

IObjectModelRO.GetHeaderText(int)

GetInputValue

public java.lang.String GetInputValue(java.lang.String strInput)

Description copied from interface: IObjectSelectionModelRO

Returns the value of the given input.

Specified by:

GetInputValue in interface IObjectSelectionModelRO

Returns:

String strValue

See Also:

IObjectSelectionModelRO.GetInputValue(String)

GetIsCollapsable

public boolean GetIsCollapsable()

Description copied from interface: IObjectModelRO

Gets whether or not the object banner should be collapsable.

Specified by:

GetIsCollapsable in interface IObjectModelRO

Returns:

boolean true implies collapsible.

See Also:

IObjectModelRO.GetIsCollapsable()

GetIsFolderSelected

public boolean GetIsFolderSelected(int nFolderID)

Description copied from interface: IFolderModelRO

This method returns whether or not the requested folder is currently selected.

Specified by:

GetIsFolderSelected in interface IFolderModelRO

Returns:

boolean true implies selected, false implies not selected

See Also:

IFolderModelRO.GetShowCheckbox()

GetIsObjectSelected

public boolean GetIsObjectSelected(int nObjectID)

Description copied from interface: IObjectModelRO

This method returns whether or not the requested object ID is currently selected.

Specified by:

GetIsObjectSelected in interface IObjectModelRO

Returns:

boolean true implies selected, false implies not selected

See Also:

IObjectModelRO.GetIsObjectSelected(int)

GetLastFolderIndex

public int GetLastFolderIndex()

Description copied from interface: IFolderModelRO

Get the index of the first folder to display.

Specified by:

GetLastFolderIndex in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetLastItemIndex()

GetMultipleSelect

public boolean GetMultipleSelect()

Description copied from interface: IObjectSelectionModelRO

Get wether we can select multiple or single.

Specified by:

GetMultipleSelect in interface IObjectSelectionModelRO

Returns:

boolean

See Also:

IObjectSelectionModelRO.GetMultipleSelect()

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:

String

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IModelRO#GetName()

GetNumObjects

public int GetNumObjects()

See Also:

com.plumtree.portalpages.common.objects.IPaginationModelRO#GetNumObjects()

GetNumSubSubFolders

public int GetNumSubSubFolders()

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetNumSubSubFolders()

GetNumSubSubFoldersToDisplay

public int GetNumSubSubFoldersToDisplay()

Description copied from interface: IFolderModelRO

Set the number of sub-subfolders to display after the next page..

Specified by:

GetNumSubSubFoldersToDisplay in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetNumSubSubFolders()

GetObjectBannerTitle

public java.lang.String GetObjectBannerTitle()

Description copied from interface: IObjectModelRO

Gets the name of the current folder.

Specified by:

GetObjectBannerTitle in interface IObjectModelRO

Returns:

String strCurrentFolderName

See Also:

IObjectModelRO.GetObjectBannerTitle()

GetObjectColumnCount

public int GetObjectColumnCount()

Description copied from interface: IObjectModelRO

Gets the number of columns of objects

Specified by:

GetObjectColumnCount in interface IObjectModelRO

Returns:

int nColumnCount

See Also:

com.plumtree.portalpages.common.objects.IObjectModelRO#GetColumnCount()

GetObjectCount

public int GetObjectCount()

Description copied from interface: IObjectModelRO

Gets the count of the objects in the query result.

Specified by:

GetObjectCount in interface IObjectModelRO

Returns:

int nObjectCount

See Also:

IObjectModelRO.GetObjectCount()

GetObjectFields

public java.lang.Object GetObjectFields(int nIndex,
                                        int ptPropID)

Description copied from interface: IObjectModelRO

Gets the fields from the query result.

Specified by:

GetObjectFields in interface IObjectModelRO

Parameters:

nIndex - nIndex

ptPropID - nPropID

Returns:

Object oFields

See Also:

IObjectModelRO.GetObjectFields(int, int)

GetObjectType

public int GetObjectType()

Description copied from interface: IObjectModelRO

Get the Object Class ID of the type of objects we are currently viewing.

Specified by:

GetObjectType in interface IObjectModelRO

Returns:

int the class ID of the object

See Also:

IObjectModelRO#GetObjectType()

GetObjectSubType

public int GetObjectSubType(int nIndex)

Description copied from interface: IObjectModelRO

Get the subtype of the object at the given index.

Specified by:

GetObjectSubType in interface IObjectModelRO

Parameters:

nIndex - index of the object in the list.

Returns:

the subtype of the object, or -1 if the object has no subtype.

See Also:

com.plumtree.portalpages.common.objects.IObjectModelRO#GetObjectSubType()

GetObjectViewIsCollapsed

public boolean GetObjectViewIsCollapsed()

Description copied from interface: IObjectModelRO

Get whether the object view is collapsed. This is only relevant if GetIsCollapsable() returns true.

Specified by:

GetObjectViewIsCollapsed in interface IObjectModelRO

Returns:

bObjectViewIsCollapsed

See Also:

IObjectModelRO.GetObjectViewIsCollapsed()

GetPTSession

public IPTSession GetPTSession()

Get the session

Returns:

IPTSession ptSession

GetParentFolderID

public int GetParentFolderID()

Description copied from interface: IFolderModelRO

Get the ID of the parent folder of the current folder.

Specified by:

GetParentFolderID in interface IFolderModelRO

See Also:

IFolderModelRO.GetParentFolderID()

GetParentFolderIDs

public java.lang.Object[] GetParentFolderIDs()

Description copied from interface: IFolderModelRO

Get an Object array containing the Integer IDs of all the parent folders (the path) of the current folder. Each element in the array must be cast to an Integer. This will return one ID per folder in the path, except for the root folder, where two IDs will be returned even though there is only one folder in the path.

Specified by:

GetParentFolderIDs in interface IFolderModelRO

See Also:

IFolderModelRO.GetParentFolderIDs()

GetParentFormName

public java.lang.String GetParentFormName()

Description copied from interface: IObjectSelectionModelRO

Get the name of the parent window's form.

Specified by:

GetParentFormName in interface IObjectSelectionModelRO

Returns:

String

See Also:

IObjectSelectionModelRO.GetParentFormName()

GetParentFormSelectedItems

public java.lang.String GetParentFormSelectedItems()

Description copied from interface: IObjectSelectionModelRO

Get the name of the form element for selected items.

Specified by:

GetParentFormSelectedItems in interface IObjectSelectionModelRO

Returns:

String

See Also:

IObjectSelectionModelRO.GetParentFormSelectedItems()

GetParentFormSpaceID

public java.lang.String GetParentFormSpaceID()

Description copied from interface: IObjectSelectionModelRO

Get the string that is the parent form space ID.

Specified by:

GetParentFormSpaceID in interface IObjectSelectionModelRO

Returns:

String

See Also:

IObjectSelectionModelRO.GetParentFormSpaceID()

GetParentFormSubmitFunction

public java.lang.String GetParentFormSubmitFunction()

Description copied from interface: IObjectSelectionModelRO

Get the string that is the parent form submit function.

Specified by:

GetParentFormSubmitFunction in interface IObjectSelectionModelRO

Returns:

String

See Also:

IObjectSelectionModelRO.GetParentFormSubmitFunction()

GetPath

public java.lang.String GetPath()

Description copied from interface: IFolderModelRO

Get the path to the current folder concatenated with '\'.

Specified by:

GetPath in interface IFolderModelRO

See Also:

IFolderModelRO.GetPath()

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish()

Returns the Obj Manager Redirect object (this is were we need to go at the end of the Editor).

Specified by:

GetRedirectAfterFinish in interface IRepostModel

Overrides:

GetRedirectAfterFinish in class EditorModel

Returns:

Redirect

GetRemovedObjectsForParent

public XPSortedDictionary GetRemovedObjectsForParent()

Gets the selected objects from this object selector.

Returns:

XPSortedDictionary

GetSearchStarted

public boolean GetSearchStarted()

Description copied from interface: IObjectSelectionModelRO

Returns true if a search has been initialized.

Specified by:

GetSearchStarted in interface IObjectSelectionModelRO

Returns:

boolean

See Also:

IObjectSelectionModelRO.GetSearchStarted()

GetSelectedNamesAsString

public java.lang.String GetSelectedNamesAsString()

Description copied from interface: IObjectSelectionModelRO

Get the selected names as a string.

Specified by:

GetSelectedNamesAsString in interface IObjectSelectionModelRO

Returns:

String strSelectedNames

See Also:

IObjectSelectionModelRO.GetSelectedNamesAsString()

GetSelectedObjectsForParent

public XPSortedDictionary GetSelectedObjectsForParent()

Gets the selected objects from this object selector.

Returns:

XPSortedDictionary

GetSelectionModelHelper

public IObjectSelectionModelHelper GetSelectionModelHelper()

Returns:

GetSelectorClassID

public int GetSelectorClassID()

Get the selector's class ID.

Specified by:

GetSelectorClassID in interface IObjectSelectionModelRO

Returns:

int nSelectorClassID

GetSelectorCommunityFolderID

public int GetSelectorCommunityFolderID()

Description copied from interface: IObjectSelectionModelRO

Get the selector's community folder ID.

Specified by:

GetSelectorCommunityFolderID in interface IObjectSelectionModelRO

Returns:

int nSelectorCommunityFolderID

See Also:

IObjectSelectionModelRO.GetSelectorCommunityFolderID()

GetSelectorObjectID

public int GetSelectorObjectID()

Get the selector's object ID.

Specified by:

GetSelectorObjectID in interface IObjectSelectionModelRO

Returns:

int nSelectorObjectID

GetSelectorPageID

public int GetSelectorPageID()

Get the selector's page ID.

Specified by:

GetSelectorPageID in interface IObjectSelectionModelRO

Returns:

int nSelectorPageID

GetSelectorCommunityID

public int GetSelectorCommunityID()

Get the selector's community ID.

Specified by:

GetSelectorCommunityID in interface IObjectSelectionModelRO

Returns:

int

GetShowCheckbox

public boolean GetShowCheckbox()

Description copied from interface: IFolderModelRO

Returns whether the folders should have checkboxes next to them.

Specified by:

GetShowCheckbox in interface IFolderModelRO

See Also:

IFolderModelRO.GetShowCheckbox()

GetShowEditIcon

public boolean GetShowEditIcon()

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetShowEditIcon()

GetShowFolderBanner

public boolean GetShowFolderBanner()

Description copied from interface: IFolderModelRO

Returns whether the subfolder banner should be shown.

Specified by:

GetShowFolderBanner in interface IFolderModelRO

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetShowBanner()

GetShowPagination

public boolean GetShowPagination()

Description copied from interface: IObjectModelRO

Get whether these objects should use pagination or not. If this is true, the header will have a pagination bar. If this is true, the AActivitySpace will need to include the pagination framework (pass-thru repost control & implement pagination model interface).

Specified by:

GetShowPagination in interface IObjectModelRO

Returns:

boolean true implies show pagination bar

See Also:

IObjectModelRO.GetShowPagination()

GetSortDirection

public int GetSortDirection()

See Also:

com.plumtree.portalpages.common.objects.IObjectModelRO#GetSortDirection()

GetSortable

public boolean GetSortable()

Description copied from interface: IObjectModelRO

Get whether these objects are sortable or not. If this is true, the headers will be sortable. If this is true, the AActivitySpace will need to include the sortable framework (pass-thru repost control & implement sortable model interface).

Specified by:

GetSortable in interface IObjectModelRO

Returns:

boolean true implies sortable

See Also:

IObjectModelRO.GetSortable()

GetSortedHeader

public int GetSortedHeader()

See Also:

com.plumtree.portalpages.common.objects.IObjectModelRO#GetSortedHeader()

GetSpaceID

public java.lang.String GetSpaceID()

Get the SpaceID of the parent Activity Space

Specified by:

GetSpaceID in interface IObjectModelRO

Returns:

int m_asOwner.GetSpaceID();

GetSubFolderCount

public int GetSubFolderCount(int nFolderLevel)

Description copied from interface: IFolderModelRO

Get the number of sub folders in the current folder at the specified level.

Specified by:

GetSubFolderCount in interface IFolderModelRO

See Also:

Get all subfolders in query and disregard the folder level

GetSubFolderCount

public int GetSubFolderCount()

Description copied from interface: IFolderModelRO

Get the number of folders at all levels in the hierachy

Specified by:

GetSubFolderCount in interface IFolderModelRO

See Also:

Get the number of folders at all levels in the hierachy

GetSubSubFolderInfo

public XPArrayList GetSubSubFolderInfo(int nSubFolderIndex,
                                       int nInfoType)

See Also:

com.plumtree.portalpages.common.folder.IFolderModelRO#GetSubSubFolderInfo(int, int)

GetTemporaryInvitationID

public int GetTemporaryInvitationID()

Temporary value, filled in by invitation controls, that gives the ID of the object to the invitation view.

Specified by:

GetTemporaryInvitationID in interface IObjectSelectionModelRO

Returns:

int

GetTemporaryInvitationName

public java.lang.String GetTemporaryInvitationName()

Temporary value, filled in by invitation controls, that gives the name of the object to the invitation view.

Specified by:

GetTemporaryInvitationName in interface IObjectSelectionModelRO

Returns:

String

InRootFolder

public boolean InRootFolder()

Description copied from interface: IFolderModelRO

Returns true if the current folder is the root folder.

Specified by:

InRootFolder in interface IFolderModelRO

See Also:

IFolderModelRO.InRootFolder()

OpenSubFolder

public void OpenSubFolder(int _nFolderID)

Description copied from interface: IFolderModel

Open the folder with the id ID. This method should change the model to contain data for the new folder.

Specified by:

OpenSubFolder in interface IFolderModel

See Also:

IFolderModel.OpenSubFolder(int)

RepostAddObject

public void RepostAddObject()

RepostAddPortletsFromBundle

public void RepostAddPortletsFromBundle()

Method RepostAddPortletsFromBundle. Add and remove portlets from bundle.

RepostOpenFolder

public void RepostOpenFolder()

Method RepostOpenFolder. Opens a folder on repost.

RepostRemoveObject

public void RepostRemoveObject()

RepostSelectPortletBundle

public void RepostSelectPortletBundle()

Method RepostSelectPortletBundle. Add all portlets from the portlet bundle to the list of selected portlets.

RepostToSearch

public void RepostToSearch()

Modifies the object name on repost.

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

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

SetDisplaySearch

public void SetDisplaySearch(boolean _bDisplaySearch)

Description copied from interface: IObjectSelectionModel

This method is used by the portlet flyout control to switch from browse mode to search mode.

Specified by:

SetDisplaySearch in interface IObjectSelectionModel

Parameters:

_bDisplaySearch - whether or not we are in search mode.

See Also:

IObjectSelectionModel.SetDisplaySearch(boolean)

SetFirstItemIndex

public void SetFirstItemIndex(int nFirstItemIndex)

Description copied from interface: IFolderModel

Set the index of the first folder to display on a page.

Specified by:

SetFirstItemIndex in interface IFolderModel

See Also:

IFolderModel.SetFirstItemIndex(int)

SetHost

public void SetHost(java.lang.String strHost)

Parameters:

strHost -

SetLastItemIndex

public void SetLastItemIndex(int nLastItemIndex)

Description copied from interface: IFolderModel

Set the index of the first folder to display on a page.

Specified by:

SetLastItemIndex in interface IFolderModel

See Also:

IFolderModel.SetLastItemIndex(int)

SetNeverFlatView

public void SetNeverFlatView(boolean bNeverFlatView)

Parameters:

bNeverFlatView -

SetNumSubSubFolders

public void SetNumSubSubFolders(int nSubSubFolders)

See Also:

com.plumtree.portalpages.common.folder.IFolderModel#SetNumSubSubFolders(int)

SetObjectViewIndex

public void SetObjectViewIndex(int nObjectViewIndex)

Description copied from interface: IObjectSelectionModel

Sets the index of the object view the page is currently displaying. Called from the class displaying the different object types.

Specified by:

SetObjectViewIndex in interface IObjectSelectionModel

See Also:

IObjectSelectionModel.SetObjectViewIndex(int)

SetSelectionModelHelper

public void SetSelectionModelHelper(IObjectSelectionModelHelper selectionModelHelper)

Sets the Selection Model Helper for the Selection Model to use. This must be called after Init is called.

Parameters:

selectionModelHelper - selectionModelHelper

SetShowFolderBanner

public void SetShowFolderBanner(boolean bShowBanner)

Parameters:

bShowBanner -

SetTemporaryInvitationID

public void SetTemporaryInvitationID(int nTemporaryInvitationID)

Temporary value, filled in by invitation controls, that gives the ID of the object to the invitation view.

Parameters:

strTemporaryInvitationID -

SetTemporaryInvitationName

public void SetTemporaryInvitationName(java.lang.String strTemporaryInvitationName)

Temporary value, filled in by invitation controls, that gives the name of the object to the invitation view.

Parameters:

strTemporaryInvitationName - Name to display in invitation popup.

ShowObjectBanner

public boolean ShowObjectBanner()

Description copied from interface: IObjectModelRO

Get whether to show the banner or not.

Specified by:

ShowObjectBanner in interface IObjectModelRO

Returns:

boolean true implies show banner

See Also:

IObjectModelRO.ShowObjectBanner()

SaveMainPage

protected void SaveMainPage(XPHashtable _htFormData)

Saves the data on the Main page.

Parameters:

_htFormData -

AddNewlySelected

public void AddNewlySelected(java.lang.String _strObjectID,
                             java.lang.String _strAlignment,
                             java.lang.String _strName)

Adds a newly selected object to the list so that the objects can be added permanently when the user clicks on finish.

Parameters:

_strObjectID, - _strAlignment, _strName

RemoveObject

public void RemoveObject(java.lang.String _strObjectID)

Removes an object from the newselected list so that it will not get added when the user clicks on finish.

Parameters:

_strObjectID -

InitializeSearchSettingCollection

protected void InitializeSearchSettingCollection()

Sets up the initial configuration of the search for portlets or comunities. Sets the search sort order and grouping by last modified.

GetSearchSettingCollection

public SearchSettingCollection GetSearchSettingCollection()

Description copied from interface: IObjectSelectionModelRO

Returns the Search Setting Collection.

Specified by:

GetSearchSettingCollection in interface IObjectSelectionModelRO

Returns:

SearchSettingCollection

GetBreadCrumbPath

public IASQueryResult GetBreadCrumbPath()

Description copied from interface: IObjectSelectionModelRO

This method returns a 2d query result with folder level, id, and name.

Specified by:

GetBreadCrumbPath in interface IObjectSelectionModelRO

Returns:

IASQueryResult

IsHomeMyPage

public boolean IsHomeMyPage()

Specified by:

IsHomeMyPage in interface IObjectSelectionModelRO

See Also:

IObjectSelectionModelRO.IsHomeMyPage()

IsCommunityPage

public boolean IsCommunityPage()

Specified by:

IsCommunityPage in interface IObjectSelectionModelRO

See Also:

IObjectSelectionModelRO.IsCommunityPage()

IsMyPage

public boolean IsMyPage()

Specified by:

IsMyPage in interface IObjectSelectionModelRO

See Also:

IObjectSelectionModelRO.IsMyPage()

IsPageTemplate

public boolean IsPageTemplate()

Specified by:

IsPageTemplate in interface IObjectSelectionModelRO

See Also:

IObjectSelectionModelRO.IsPageTemplate()

SetSortPropertyId

public void SetSortPropertyId(int sortPropertyId)

GetSortPropertyId

public int GetSortPropertyId()

Description copied from interface: IObjectSelectionModelRO

Gets the current property id that the model is ordered by.

Specified by:

GetSortPropertyId in interface IObjectSelectionModelRO

Returns:

SetFirstDisplayableItem

public void SetFirstDisplayableItem(int _nFirstItem)

Description copied from interface: IObjectSelectionModel

Set the first displayable item for pagination in the object selection model if pagination is used.

Specified by:

SetFirstDisplayableItem in interface IObjectSelectionModel

See Also:

IObjectSelectionModel.SetFirstDisplayableItem(int)

SetItemsPerPage

public void SetItemsPerPage(int _nItemsPerPage)

Description copied from interface: IObjectSelectionModel

Set the number of items per page for pagination in the object selection model if pagination is used.

Specified by:

SetItemsPerPage in interface IObjectSelectionModel

See Also:

IObjectSelectionModel.SetItemsPerPage(int)

GetFirstDisplayableItem

public int GetFirstDisplayableItem()

Description copied from interface: IObjectSelectionModelRO

Get the first displayable item for pagination in the object selection model if pagination is used.

Specified by:

GetFirstDisplayableItem in interface IObjectSelectionModelRO

Returns:

the first displayable item.

See Also:

IObjectSelectionModelRO.GetFirstDisplayableItem()

GetItemsPerPage

public int GetItemsPerPage()

Description copied from interface: IObjectSelectionModelRO

Get the number of items per page for pagination in the object selection model if pagination is used.

Specified by:

GetItemsPerPage in interface IObjectSelectionModelRO

Returns:

the number of items per page.

See Also:

IObjectSelectionModelRO.GetItemsPerPage()

GetTotalItems

public int GetTotalItems()

Description copied from interface: IObjectSelectionModelRO

Get the total number of items for pagination in the object selection model if pagination is used. This includes all object types currently being displayed.

Specified by:

GetTotalItems in interface IObjectSelectionModelRO

Returns:

the total number of items.

See Also:

IObjectSelectionModelRO.GetTotalItems()