com.plumtree.portalpages.browsing.sitemap.sitemappage
Class SiteMapModel

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AClearModel
      com.plumtree.portalpages.browsing.sitemap.sitemappage.SiteMapModel

All Implemented Interfaces:

ISiteMapModelRO, IFolderModel, IFolderModelRO, IObjectModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IRepostModel, IPaginationModel, IPaginationModelRO, ISortModel, ISortModelRO

public class SiteMapModel
extends AClearModel
implements ISiteMapModelRO, IFolderModel, IRepostModel, ISortModel, IPaginationModel

File: SiteMapModel.java ----------------------- This model contains data for the Site Map.

Author:

NaveenP

Field Summary

static int	FOLDERID_NOT_INITIALIZED
int	m_nFirstLinkObjectCount
int	m_nFirstMemberObjectCount
int	m_nLastLinkObjectCount
int	m_nLastMemberObjectCount
int	m_nObjectType
protected IPTSession	m_ptSession Store session and catalog to retrieve data
static int	NO_FOLDER_SELECTED
static java.lang.String	STR_MVC_CLASS_NAME Activity space name

Constructor Summary

SiteMapModel()

Method Summary

void	ClearGroups()
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	CreateFolder(java.lang.String strName, java.lang.String strDesc)
static int	CreateSortedLinks(IPTSiteMapFolderInfo ptSiteMapFolderInfo, ASCompoundList cpList, java.lang.String strLinkOrder, AActivitySpace owner)
void	CreateSortedSubFolders()
void	Delete()
boolean	DoNotShowObject(int nIndex) Get whether to show this object or not.
void	Finish() Implement some code to execute when the user clicks on "Finish".
static void	GetASCompoundListForSiteMapFolder(IPTSiteMapFolderInfo ptSiteMapFolderInfo, ASCompoundList cpList)
static void	GetASCompoundListForSiteMapFolder(PTSortedArrayWrapper arrSortedLinks, ASCompoundList cpList, AActivitySpace owner)
int	GetCommunityID()
PTSortedArrayWrapper	GetCommunityPages()
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	GetCurrentGroupID()
int	GetCurrentGroupMemberCount()
IASQueryResult	GetCurrentGroupMembers()
java.lang.String	GetCurrentGroupName()
int	GetCurrentLowerObjectCount() This method returns the current lower count for which objects to display.
int	GetCurrentUpperObjectCount() This method returns the current upper count for which objects to display.
boolean	GetDisplayPaginationHiddenInputs() Get whether or not to display the hidden inputs needed by the PaginationControl.
boolean	GetDisplaySortHiddenInputs() Get whether or not to display the hidden inputs needed by the SortControl.
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 the folder view helper.
ASURL	GetGroupGoUpURL()
java.lang.String	GetGroupPath()
boolean	GetHasEditAccessToFolder()
int	GetHeaderCount() Gets the count of the object headers.
boolean	GetHeaderHasCheckbox() Returns whether the header has a checkbox or not.
int	GetHeaderID(int nCommunityID) Return the headerID for the community; used when processing the style sheet.
HTMLTableRow	GetHeaderRow() Returns the header row
java.lang.String	GetHeaderText(int nHeaderIndex) Gets the text of the header at the given index.
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	GetLastFolderIndex() Get the index of the first folder to display.
ICPListEntryIterator	GetListIterator()
int	GetMode()
java.lang.String	GetName() Return the name of the MVC object.
java.lang.Object	GetNewTempData() This method returns a new temporary data object.
int	GetNumObjects() This method returns the total number of objects available for display.
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 nPropID) 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	GetPaginationSize() This is the number of objects displayed per page.
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.Object[]	GetParentGroupIDs()
java.lang.String	GetPath() Get the path to the current folder concatenated with '\'.
Redirect	GetRedirectAfterFinish() Returns the Redirect object (this is were we need to go at the end of the Editor).
boolean	GetShowCheckbox() Returns whether the folders should have checkboxes next to them.
boolean	GetShowFolderBanner() Returns whether the subfolder banner should be shown.
boolean	GetShowPagination() Get whether these objects should use pagination or not.
int	GetSiteMapRootID()
java.lang.String	GetSiteMapRootName()
boolean	GetSortable() Get whether these objects are sortable or not.
int	GetSortDirection() Get the sort direction for the currently sorted header column.
int	GetSortedHeader() Get the column id of the header that is currently sorted (starting with 0).
PTSortedArrayWrapper	GetSortedSubFolders()
PTSortedArrayWrapper	GetSortedSubSubFoldersFromParentID(int intFolderID)
java.lang.String	GetSpaceID() Get the SpaceID of the parent Activity Space
java.lang.String	GetStyleSheet(int nCommunityID) Return the stylesheet for the community; used when processing the style sheet.
ASQueryResultWrapper	GetSubCommunities()
int	GetSubFolderCount() Get the number of folders at all levels in the hierachy
int	GetSubFolderCount(int nLevel) Get the number of sub folders in the current folder at the specified level.
int	GetSubGroupCount()
IASQueryResult	GetSubGroups()
ASQueryResultWrapper	GetTopLevelGroups()
void	Init(AActivitySpace parent) This method initializes the model.
boolean	InRootFolder() Returns true if the current folder is the root folder.
boolean	IsBrowseMode()
boolean	IsEditMode()
boolean	IsGroupAccessible(int nGroupID)
boolean	IsPreviewPage()
void	Move()
void	OpenSubFolder(int ID) Open the folder with the id ID.
void	RefreshCurrentGroupID() Refresh the current group ID.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetBrowseMode()
void	SetCommunityID(int nCommunityID) Set Community ID
void	SetEditMode()
void	SetFirstItemIndex(int nFirstItemIndex) Set the index of the first folder to display on a page.
boolean	SetGroupID(int nGroupID) This sets the group ID after checking if the group is accessible to the current user.
void	SetLastItemIndex(int nLastItemIndex) Set the index of the first folder to display on a page.
void	SetObjectType(int nNewObjectType) This activity space holds only cards, so no need to change the type.
void	SetPagination(int nPaginationID, int nPaginationLowerBound, int nPaginationUpperBound) This is used by the PaginationControl to set which objects should be displayed.
void	SetSort(int nSortID, int nSortHeader, int nSortDirection) Set the sort to use.
void	SetToPreviewPage()
boolean	ShowObjectBanner() Get whether to show the banner or not.
boolean	SiteMapDisabled()

Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel

CleanupAllData, CleanupTempData, GetTempData

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.activityspace.IModel

CleanupAllData, CleanupTempData

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Activity space name

See Also:

Constant Field Values

NO_FOLDER_SELECTED

public static final int NO_FOLDER_SELECTED

See Also:

Constant Field Values

FOLDERID_NOT_INITIALIZED

public static final int FOLDERID_NOT_INITIALIZED

See Also:

Constant Field Values

m_nObjectType

public int m_nObjectType

m_ptSession

protected IPTSession m_ptSession

Store session and catalog to retrieve data

m_nFirstLinkObjectCount

public int m_nFirstLinkObjectCount

m_nLastLinkObjectCount

public int m_nLastLinkObjectCount

m_nFirstMemberObjectCount

public int m_nFirstMemberObjectCount

m_nLastMemberObjectCount

public int m_nLastMemberObjectCount

Constructor Detail

SiteMapModel

public SiteMapModel()

Method Detail

ClearGroups

public void ClearGroups()

Create

public java.lang.Object Create()

Description copied from class: AClearModel

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 AClearModel

Returns:

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

See Also:

IManagedObject.Create()

CreateSortedSubFolders

public void CreateSortedSubFolders()

Delete

public void Delete()

Throws:

java.lang.Exception

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)

Finish

public void Finish()

Description copied from interface: IRepostModel

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

Specified by:

Finish in interface IRepostModel

See Also:

IRepostModel.Finish()

GetASCompoundListForSiteMapFolder

public static void GetASCompoundListForSiteMapFolder(IPTSiteMapFolderInfo ptSiteMapFolderInfo,
                                                     ASCompoundList cpList)

Parameters:

ptSiteMapFolderInfo -

cpList -

GetASCompoundListForSiteMapFolder

public static void GetASCompoundListForSiteMapFolder(PTSortedArrayWrapper arrSortedLinks,
                                                     ASCompoundList cpList,
                                                     AActivitySpace owner)

Parameters:

arrSortedLinks -

cpList -

CreateSortedLinks

public static int CreateSortedLinks(IPTSiteMapFolderInfo ptSiteMapFolderInfo,
                                    ASCompoundList cpList,
                                    java.lang.String strLinkOrder,
                                    AActivitySpace owner)

GetCommunityID

public int GetCommunityID()

Specified by:

GetCommunityID in interface ISiteMapModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#GetCommunityID()

GetCommunityPages

public PTSortedArrayWrapper GetCommunityPages()

Specified by:

GetCommunityPages in interface ISiteMapModelRO

Returns:

ASQueryResultWrapper

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

GetCurrentGroupMemberCount

public int GetCurrentGroupMemberCount()

Returns:

int

GetCurrentGroupMembers

public IASQueryResult GetCurrentGroupMembers()

Returns:

IASQueryResult

GetCurrentGroupName

public java.lang.String GetCurrentGroupName()

Returns:

String

GetCurrentLowerObjectCount

public int GetCurrentLowerObjectCount()

Description copied from interface: IPaginationModelRO

This method returns the current lower count for which objects to display. This number is the 'n' in (Displaying n - m of o)

Specified by:

GetCurrentLowerObjectCount in interface IPaginationModelRO

Returns:

int the current lower count for which objects to display.

See Also:

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

GetCurrentUpperObjectCount

public int GetCurrentUpperObjectCount()

Description copied from interface: IPaginationModelRO

This method returns the current upper count for which objects to display. This number is the 'm' in (Displaying n - m of o)

Specified by:

GetCurrentUpperObjectCount in interface IPaginationModelRO

Returns:

int the current upper count for which objects to display.

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

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:

IFolderModelRO.GetFirstFolderIndex()

GetFolderColumnCount

public int GetFolderColumnCount()

Description copied from interface: IFolderModelRO

Get the number of columns to display.

Specified by:

GetFolderColumnCount in interface IFolderModelRO

See Also:

IFolderModelRO.GetFolderColumnCount()

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:

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

GetFolderViewHelper

public IFolderViewHelper GetFolderViewHelper()

Description copied from interface: IFolderModelRO

Retrieves the folder view helper. This contains a method to implement display for one folder. FolderViewHelper is the implementation for general use, but you may need to implement your own helper.

Specified by:

GetFolderViewHelper in interface IFolderModelRO

See Also:

IFolderModelRO.GetFolderViewHelper()

GetGroupGoUpURL

public ASURL GetGroupGoUpURL()

Returns:

ASURL

GetGroupPath

public java.lang.String GetGroupPath()

Returns:

String

GetHasEditAccessToFolder

public boolean GetHasEditAccessToFolder()

Specified by:

GetHasEditAccessToFolder in interface ISiteMapModelRO

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)

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:

IFolderModelRO.GetLastFolderIndex()

GetListIterator

public ICPListEntryIterator GetListIterator()

Returns:

ICPListEntryIterator

GetMode

public int GetMode()

Specified by:

GetMode in interface ISiteMapModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#GetMode()

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class AClearModel

Returns:

the name of the object.

See Also:

com.plumtree.xpshared.activityspace.IModel#GetName()

GetNewTempData

public java.lang.Object GetNewTempData()

Description copied from class: AClearModel

This method returns a new temporary data object. It is called at the beginning of a new HTTP Request. This method can perform initialization on the data object if necessary.

Specified by:

GetNewTempData in class AClearModel

Returns:

Object the new temporary data object

See Also:

com.plumtree.uiinfrastructure.activityspace.AClearModel#GetNewm_TempData()

GetNumObjects

public int GetNumObjects()

Description copied from interface: IPaginationModelRO

This method returns the total number of objects available for display. This number is the 'o' in (Displaying n - m of o)

Specified by:

GetNumObjects in interface IPaginationModelRO

Returns:

int the total number of objects available for display.

See Also:

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

GetPaginationSize

public int GetPaginationSize()

Description copied from interface: IPaginationModelRO

This is the number of objects displayed per page. This name is the value of (m - n)

Specified by:

GetPaginationSize in interface IPaginationModelRO

Returns:

int the total number of objects available for display per page

See Also:

IPaginationModelRO.GetPaginationSize()

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:

IObjectModelRO.GetObjectColumnCount()

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

Description copied from interface: IObjectModelRO

Gets the fields from the query result.

Specified by:

GetObjectFields in interface IObjectModelRO

Parameters:

nIndex - nIndex

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

com.plumtree.portalpages.common.folder.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()

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

GetParentGroupIDs

public java.lang.Object[] GetParentGroupIDs()

Returns:

Object[]

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

Description copied from interface: IRepostModel

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

Specified by:

GetRedirectAfterFinish in interface IRepostModel

Returns:

Redirect

See Also:

IRepostModel.GetRedirectAfterFinish()

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

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

GetSiteMapRootID

public int GetSiteMapRootID()

Specified by:

GetSiteMapRootID in interface ISiteMapModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#GetSiteMapRootID()

GetSiteMapRootName

public java.lang.String GetSiteMapRootName()

GetSortDirection

public int GetSortDirection()

Description copied from interface: ISortModelRO

Get the sort direction for the currently sorted header column. This should return either PTSortedArrayWrapper.PTSAW_SORT_ASCENDING or PTSortedArrayWrapper.PTSAW_SORT_DESCENDING. This method only needs to return useful information if GetSortable() returns true.

Specified by:

GetSortDirection in interface ISortModelRO

Returns:

int the sort direction from PTSortedArrayWrapper.

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

Description copied from interface: ISortModelRO

Get the column id of the header that is currently sorted (starting with 0). This method only needs to return useful information if GetSortable() returns true.

Specified by:

GetSortedHeader in interface ISortModelRO

Returns:

int the column id of the currently sorted header column.

See Also:

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

GetSortedSubFolders

public PTSortedArrayWrapper GetSortedSubFolders()

Returns:

PTSortedArrayWrapper

GetSortedSubSubFoldersFromParentID

public PTSortedArrayWrapper GetSortedSubSubFoldersFromParentID(int intFolderID)

Parameters:

intFolderID -

Returns:

PTSortedArrayWrapper

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

GetSubCommunities

public ASQueryResultWrapper GetSubCommunities()

Returns:

ASQueryResultWrapper

GetSubFolderCount

public int GetSubFolderCount(int nLevel)

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:

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

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:

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

GetSubGroupCount

public int GetSubGroupCount()

Returns:

int

GetSubGroups

public IASQueryResult GetSubGroups()

Returns:

IASQueryResult

GetTopLevelGroups

public ASQueryResultWrapper GetTopLevelGroups()

Returns:

ASQueryResultWrapper

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

Init

public void Init(AActivitySpace parent)

Description copied from interface: IModel

This method initializes the model. This is called automatically when AActivitySpace.RegisterModel() is called.

Specified by:

Init in interface IModel

Overrides:

Init in class AClearModel

Parameters:

parent - the parent Activity Space

See Also:

com.plumtree.xpshared.activityspace.IModel#Init()

IsBrowseMode

public boolean IsBrowseMode()

Specified by:

IsBrowseMode in interface ISiteMapModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#IsBrowseMode()

IsEditMode

public boolean IsEditMode()

Specified by:

IsEditMode in interface ISiteMapModelRO

Returns:

See Also:

com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#IsEditMode()

GetHeaderID

public int GetHeaderID(int nCommunityID)

Return the headerID for the community; used when processing the style sheet.

GetStyleSheet

public java.lang.String GetStyleSheet(int nCommunityID)

Return the stylesheet for the community; used when processing the style sheet.

Move

public void Move()

Throws:

java.lang.Exception

OpenSubFolder

public void OpenSubFolder(int ID)

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)

SavePage

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

Description copied from interface: IRepostModel

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

Specified by:

SavePage in interface IRepostModel

SetBrowseMode

public void SetBrowseMode()

SetCommunityID

public void SetCommunityID(int nCommunityID)

Set Community ID

Parameters:

int -

SetEditMode

public void SetEditMode()

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)

GetCurrentGroupID

public int GetCurrentGroupID()

Returns:

int

RefreshCurrentGroupID

public void RefreshCurrentGroupID()

Refresh the current group ID. This is the same as setting the group ID to the current group ID, but bypasses any security checks.

SetGroupID

public boolean SetGroupID(int nGroupID)

This sets the group ID after checking if the group is accessible to the current user. NOTE: This method calls IsGroupAccessible to check security.

Parameters:

nGroupID -

Returns:

true if the group ID was set. False if the group is not accessible.

IsGroupAccessible

public boolean IsGroupAccessible(int nGroupID)

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)

SetObjectType

public void SetObjectType(int nNewObjectType)

This activity space holds only cards, so no need to change the type.

Parameters:

ID - not used

SetPagination

public void SetPagination(int nPaginationID,
                          int nPaginationLowerBound,
                          int nPaginationUpperBound)

Description copied from interface: IPaginationModel

This is used by the PaginationControl to set which objects should be displayed.

Specified by:

SetPagination in interface IPaginationModel

Parameters:

nPaginationID - Unique ID of objects to paginate (usually class id) when there are multiple pagination sections per page.

nPaginationLowerBound - The starting count for objects to display

nPaginationUpperBound - The ending count for objects to display.

See Also:

com.plumtree.portalpages.common.objects.IPaginationModel#SetPagination(int, int, int)

SetSort

public void SetSort(int nSortID,
                    int nSortHeader,
                    int nSortDirection)

Description copied from interface: ISortModel

Set the sort to use.

Specified by:

SetSort in interface ISortModel

Parameters:

nSortID - the ID of the objects to sort on.

nSortHeader - the index of the header to sort (starting with 0).

nSortDirection - PTSortedArrayWrapper.PTSAW_SORT_ASCENDING or PTSortedArrayWrapper.PTSAW_SORT_DESCENDING.

See Also:

com.plumtree.portalpages.common.objects.ISortModel#SetSort(int, int, int)

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

SiteMapDisabled

public boolean SiteMapDisabled()

CreateFolder

public void CreateFolder(java.lang.String strName,
                         java.lang.String strDesc)

IsPreviewPage

public boolean IsPreviewPage()

Specified by:

IsPreviewPage in interface ISiteMapModelRO

SetToPreviewPage

public void SetToPreviewPage()