|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.activityspace.AClearModel com.plumtree.portalpages.browsing.sitemap.sitemappage.SiteMapModel
public class SiteMapModel
File: SiteMapModel.java ----------------------- This model contains data for the Site Map.
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. |
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. |
void |
SetGroupID(int nGroupID)
|
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 |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel |
---|
CleanupAllData, CleanupTempData |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel |
---|
CleanupAllData, CleanupTempData |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel |
---|
CleanupAllData, CleanupTempData |
Field Detail |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final int NO_FOLDER_SELECTED
public static final int FOLDERID_NOT_INITIALIZED
public int m_nObjectType
protected IPTSession m_ptSession
public int m_nFirstLinkObjectCount
public int m_nLastLinkObjectCount
public int m_nFirstMemberObjectCount
public int m_nLastMemberObjectCount
Constructor Detail |
---|
public SiteMapModel()
Method Detail |
---|
public void ClearGroups()
public java.lang.Object Create()
AClearModel
Create
in interface IManagedObject
Create
in class AClearModel
IManagedObject.Create()
public void CreateSortedSubFolders()
public void Delete()
java.lang.Exception
public boolean DoNotShowObject(int nIndex)
IObjectModelRO
DoNotShowObject
in interface IObjectModelRO
IObjectModelRO.DoNotShowObject(int)
public void Finish()
IRepostModel
Finish
in interface IRepostModel
IRepostModel.Finish()
public static void GetASCompoundListForSiteMapFolder(IPTSiteMapFolderInfo ptSiteMapFolderInfo, ASCompoundList cpList)
ptSiteMapFolderInfo
- cpList
- public static void GetASCompoundListForSiteMapFolder(PTSortedArrayWrapper arrSortedLinks, ASCompoundList cpList, AActivitySpace owner)
arrSortedLinks
- cpList
- public static int CreateSortedLinks(IPTSiteMapFolderInfo ptSiteMapFolderInfo, ASCompoundList cpList, java.lang.String strLinkOrder, AActivitySpace owner)
public int GetCommunityID()
GetCommunityID
in interface ISiteMapModelRO
com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#GetCommunityID()
public PTSortedArrayWrapper GetCommunityPages()
GetCommunityPages
in interface ISiteMapModelRO
public int GetCurrentFolderID()
IFolderModelRO
GetCurrentFolderID
in interface IFolderModelRO
IFolderModelRO.GetCurrentFolderID()
public int GetCurrentFolderLevel()
IFolderModelRO
GetCurrentFolderLevel
in interface IFolderModelRO
IFolderModelRO.GetCurrentFolderLevel()
public java.lang.String GetCurrentFolderName()
IFolderModelRO
GetCurrentFolderName
in interface IFolderModelRO
IFolderModelRO.GetCurrentFolderName()
public int GetCurrentGroupMemberCount()
public IASQueryResult GetCurrentGroupMembers()
public java.lang.String GetCurrentGroupName()
public int GetCurrentLowerObjectCount()
IPaginationModelRO
GetCurrentLowerObjectCount
in interface IPaginationModelRO
com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentLowerObjectIndex()
public int GetCurrentUpperObjectCount()
IPaginationModelRO
GetCurrentUpperObjectCount
in interface IPaginationModelRO
com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentUpperObjectIndex()
public boolean GetDisplayPaginationHiddenInputs()
IObjectModelRO
GetDisplayPaginationHiddenInputs
in interface IObjectModelRO
IObjectModelRO.GetDisplayPaginationHiddenInputs()
public boolean GetDisplaySortHiddenInputs()
IObjectModelRO
GetDisplaySortHiddenInputs
in interface IObjectModelRO
IObjectModelRO.GetDisplaySortHiddenInputs()
public int GetFirstFolderIndex()
IFolderModelRO
GetFirstFolderIndex
in interface IFolderModelRO
IFolderModelRO.GetFirstFolderIndex()
public int GetFolderColumnCount()
IFolderModelRO
GetFolderColumnCount
in interface IFolderModelRO
IFolderModelRO.GetFolderColumnCount()
public IASQueryResult GetFolderObjectCount()
IFolderModelRO
GetFolderObjectCount
in interface IFolderModelRO
IFolderModelRO.GetFolderObjectCount()
public IASQueryResult GetFolderQueryResult()
IFolderModelRO
GetFolderQueryResult
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderData()
public IFolderViewHelper GetFolderViewHelper()
IFolderModelRO
GetFolderViewHelper
in interface IFolderModelRO
IFolderModelRO.GetFolderViewHelper()
public ASURL GetGroupGoUpURL()
public java.lang.String GetGroupPath()
public boolean GetHasEditAccessToFolder()
GetHasEditAccessToFolder
in interface ISiteMapModelRO
public int GetHeaderCount()
IObjectModelRO
GetHeaderCount
in interface IObjectModelRO
IObjectModelRO.GetHeaderCount()
public boolean GetHeaderHasCheckbox()
IObjectModelRO
GetHeaderHasCheckbox
in interface IObjectModelRO
IObjectModelRO.GetHeaderHasCheckbox()
public HTMLTableRow GetHeaderRow()
IObjectModelRO
GetHeaderRow
in interface IObjectModelRO
IObjectModelRO.GetHeaderRow()
public java.lang.String GetHeaderText(int nHeaderIndex)
IObjectModelRO
GetHeaderText
in interface IObjectModelRO
nHeaderIndex
- nHeaderIndex
IObjectModelRO.GetHeaderText(int)
public boolean GetIsCollapsable()
IObjectModelRO
GetIsCollapsable
in interface IObjectModelRO
IObjectModelRO.GetIsCollapsable()
public boolean GetIsFolderSelected(int nFolderID)
IFolderModelRO
GetIsFolderSelected
in interface IFolderModelRO
IFolderModelRO.GetShowCheckbox()
public boolean GetIsObjectSelected(int nObjectID)
IObjectModelRO
GetIsObjectSelected
in interface IObjectModelRO
IObjectModelRO.GetIsObjectSelected(int)
public int GetLastFolderIndex()
IFolderModelRO
GetLastFolderIndex
in interface IFolderModelRO
IFolderModelRO.GetLastFolderIndex()
public ICPListEntryIterator GetListIterator()
public int GetMode()
GetMode
in interface ISiteMapModelRO
com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#GetMode()
public java.lang.String GetName()
IMVCObject
GetName
in interface IMVCObject
GetName
in class AClearModel
com.plumtree.xpshared.activityspace.IModel#GetName()
public java.lang.Object GetNewTempData()
AClearModel
GetNewTempData
in class AClearModel
com.plumtree.uiinfrastructure.activityspace.AClearModel#GetNewm_TempData()
public int GetNumObjects()
IPaginationModelRO
GetNumObjects
in interface IPaginationModelRO
com.plumtree.portalpages.common.objects.IPaginationModelRO#GetNumObjects()
public int GetPaginationSize()
IPaginationModelRO
GetPaginationSize
in interface IPaginationModelRO
IPaginationModelRO.GetPaginationSize()
public int GetNumSubSubFoldersToDisplay()
IFolderModelRO
GetNumSubSubFoldersToDisplay
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetNumSubSubFolders()
public java.lang.String GetObjectBannerTitle()
IObjectModelRO
GetObjectBannerTitle
in interface IObjectModelRO
IObjectModelRO.GetObjectBannerTitle()
public int GetObjectColumnCount()
IObjectModelRO
GetObjectColumnCount
in interface IObjectModelRO
IObjectModelRO.GetObjectColumnCount()
public int GetObjectCount()
IObjectModelRO
GetObjectCount
in interface IObjectModelRO
IObjectModelRO.GetObjectCount()
public java.lang.Object GetObjectFields(int nIndex, int nPropID)
IObjectModelRO
GetObjectFields
in interface IObjectModelRO
nIndex
- nIndexnPropID
- nPropID
IObjectModelRO.GetObjectFields(int,
int)
public int GetObjectType()
IObjectModelRO
GetObjectType
in interface IObjectModelRO
com.plumtree.portalpages.common.folder.IObjectModelRO#GetObjectType()
public int GetObjectSubType(int nIndex)
IObjectModelRO
GetObjectSubType
in interface IObjectModelRO
nIndex
- index of the object in the list.
com.plumtree.portalpages.common.objects.IObjectModelRO#GetObjectSubType()
public boolean GetObjectViewIsCollapsed()
IObjectModelRO
GetObjectViewIsCollapsed
in interface IObjectModelRO
IObjectModelRO.GetObjectViewIsCollapsed()
public int GetParentFolderID()
IFolderModelRO
GetParentFolderID
in interface IFolderModelRO
IFolderModelRO.GetParentFolderID()
public java.lang.Object[] GetParentFolderIDs()
IFolderModelRO
GetParentFolderIDs
in interface IFolderModelRO
IFolderModelRO.GetParentFolderIDs()
public java.lang.Object[] GetParentGroupIDs()
public java.lang.String GetPath()
IFolderModelRO
GetPath
in interface IFolderModelRO
IFolderModelRO.GetPath()
public Redirect GetRedirectAfterFinish()
IRepostModel
GetRedirectAfterFinish
in interface IRepostModel
IRepostModel.GetRedirectAfterFinish()
public boolean GetShowCheckbox()
IFolderModelRO
GetShowCheckbox
in interface IFolderModelRO
IFolderModelRO.GetShowCheckbox()
public boolean GetShowFolderBanner()
IFolderModelRO
GetShowFolderBanner
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetShowBanner()
public boolean GetShowPagination()
IObjectModelRO
GetShowPagination
in interface IObjectModelRO
IObjectModelRO.GetShowPagination()
public int GetSiteMapRootID()
GetSiteMapRootID
in interface ISiteMapModelRO
com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#GetSiteMapRootID()
public java.lang.String GetSiteMapRootName()
public int GetSortDirection()
ISortModelRO
GetSortDirection
in interface ISortModelRO
com.plumtree.portalpages.common.objects.IObjectModelRO#GetSortDirection()
public boolean GetSortable()
IObjectModelRO
GetSortable
in interface IObjectModelRO
IObjectModelRO.GetSortable()
public int GetSortedHeader()
ISortModelRO
GetSortedHeader
in interface ISortModelRO
com.plumtree.portalpages.common.objects.IObjectModelRO#GetSortedHeader()
public PTSortedArrayWrapper GetSortedSubFolders()
public PTSortedArrayWrapper GetSortedSubSubFoldersFromParentID(int intFolderID)
intFolderID
-
public java.lang.String GetSpaceID()
GetSpaceID
in interface IObjectModelRO
public ASQueryResultWrapper GetSubCommunities()
public int GetSubFolderCount(int nLevel)
IFolderModelRO
GetSubFolderCount
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderCount()
public int GetSubFolderCount()
IFolderModelRO
GetSubFolderCount
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderCount()
public int GetSubGroupCount()
public IASQueryResult GetSubGroups()
public ASQueryResultWrapper GetTopLevelGroups()
public boolean InRootFolder()
IFolderModelRO
InRootFolder
in interface IFolderModelRO
IFolderModelRO.InRootFolder()
public void Init(AActivitySpace parent)
IModel
Init
in interface IModel
Init
in class AClearModel
parent
- the parent Activity Spacecom.plumtree.xpshared.activityspace.IModel#Init()
public boolean IsBrowseMode()
IsBrowseMode
in interface ISiteMapModelRO
com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#IsBrowseMode()
public boolean IsEditMode()
IsEditMode
in interface ISiteMapModelRO
com.plumtree.portalpages.browsing.sitemap.ISiteMapModelRO#IsEditMode()
public int GetHeaderID(int nCommunityID)
public java.lang.String GetStyleSheet(int nCommunityID)
public void Move()
java.lang.Exception
public void OpenSubFolder(int ID)
IFolderModel
OpenSubFolder
in interface IFolderModel
IFolderModel.OpenSubFolder(int)
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
IRepostModel
SavePage
in interface IRepostModel
public void SetBrowseMode()
public void SetCommunityID(int nCommunityID)
int
- public void SetEditMode()
public void SetFirstItemIndex(int nFirstItemIndex)
IFolderModel
SetFirstItemIndex
in interface IFolderModel
IFolderModel.SetFirstItemIndex(int)
public int GetCurrentGroupID()
public void SetGroupID(int nGroupID)
nGroupID
- public boolean IsGroupAccessible(int nGroupID)
public void SetLastItemIndex(int nLastItemIndex)
IFolderModel
SetLastItemIndex
in interface IFolderModel
IFolderModel.SetLastItemIndex(int)
public void SetObjectType(int nNewObjectType)
ID
- not usedpublic void SetPagination(int nPaginationID, int nPaginationLowerBound, int nPaginationUpperBound)
IPaginationModel
SetPagination
in interface IPaginationModel
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 displaynPaginationUpperBound
- The ending count for objects to display.com.plumtree.portalpages.common.objects.IPaginationModel#SetPagination(int, int, int)
public void SetSort(int nSortID, int nSortHeader, int nSortDirection)
ISortModel
SetSort
in interface ISortModel
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.com.plumtree.portalpages.common.objects.ISortModel#SetSort(int, int, int)
public boolean ShowObjectBanner()
IObjectModelRO
ShowObjectBanner
in interface IObjectModelRO
IObjectModelRO.ShowObjectBanner()
public boolean SiteMapDisabled()
public void CreateFolder(java.lang.String strName, java.lang.String strDesc)
public boolean IsPreviewPage()
IsPreviewPage
in interface ISiteMapModelRO
public void SetToPreviewPage()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |