com.plumtree.portalpages.browsing.editors.sitemap.sitemapfolderplugin
Interface ISiteMapFolderPlugInModelRO

All Known Implementing Classes:

SiteMapFolderPlugInModel

public interface ISiteMapFolderPlugInModelRO

Author:

John Hogan This interface is implemented by the Model. It contains all the read-only mothods of the Model accessed by the Views.

Method Summary

boolean	AreCommunitiesEnabled() Are communities enabled for this subportal?
java.lang.String	GetCommPageSubSpaceID() Returns the subspace ID used by the Community Page tree control.
java.lang.String	GetDocumentSubSpaceID() Returns the subspace ID used by the Document tree control.
java.lang.String	GetEditedID() Returns the unique identifier for the web link that the user is currently editing (if any).
java.lang.String	GetExpertSubSpaceID() Returns the subspace ID used by the Expert tree control.
XPArrayList	GetLinks() Returns the Links
PTSortedArrayWrapper	GetLinksAlphaSorted() Returns the Links sorted alphabetically
int	GetObjectID() Returns the objectID for the site map folder being edited
IPTSiteMapFolder	GetPTObject() Returns the IPTSiteMapFolder object being manipulated
java.lang.String	GetSelectedCommPagesAsString() Get the selected community pages for the tree in "communityid,pageid;communityid,pageid" format (this is how the comm page tree is set to display the locations)
java.lang.String	GetSelectedDirItemsAsString() Get the selected docs and folders for the tree in the "classid, objectid" format
java.lang.String	GetSelectedUsersString() Get the selected users for the tree in the "classid, object format"
int	GetWebLinkCount() Helper method to return the number of links currently cached in the working list
java.lang.String	GetWebLinkDesc() Returns the description of the web link we are working on.
java.lang.String	GetWebLinkName() Returns the name of the web link we are working on.
java.lang.String[][]	GetWebLinks() Returns a 2D array of strings containing all of the web link information
java.lang.String	GetWebLinkURL() Returns the URL of the web link we are working on.
boolean	IsDirectoryEnabled() Is the directory enabled for this subportal?
boolean	IsDuplicated() Returns true if the site map folder is used on multiple subportals

Method Detail

GetLinks

XPArrayList GetLinks()

Returns the Links

Returns:

ASQueryResultWrapper

GetLinksAlphaSorted

PTSortedArrayWrapper GetLinksAlphaSorted()

Returns the Links sorted alphabetically

Returns:

PTSortedArrayWrapper

GetPTObject

IPTSiteMapFolder GetPTObject()

Returns the IPTSiteMapFolder object being manipulated

GetObjectID

int GetObjectID()

Returns the objectID for the site map folder being edited

Returns:

int

IsDuplicated

boolean IsDuplicated()

Returns true if the site map folder is used on multiple subportals

Returns:

boolean

GetExpertSubSpaceID

java.lang.String GetExpertSubSpaceID()

Returns the subspace ID used by the Expert tree control. This is used to ensure that trees that already exist in memory are reused instead of recreated.

Returns:

String

GetDocumentSubSpaceID

java.lang.String GetDocumentSubSpaceID()

Returns the subspace ID used by the Document tree control. This is used to ensure that trees that already exist in memory are reused instead of recreated.

Returns:

String

GetCommPageSubSpaceID

java.lang.String GetCommPageSubSpaceID()

Returns the subspace ID used by the Community Page tree control. This is used to ensure that trees that already exist in memory are reused instead of recreated.

Returns:

String

GetWebLinks

java.lang.String[][] GetWebLinks()

Returns a 2D array of strings containing all of the web link information

Returns:

String[][]

GetWebLinkDesc

java.lang.String GetWebLinkDesc()

Returns the description of the web link we are working on.

Returns:

String

GetWebLinkName

java.lang.String GetWebLinkName()

Returns the name of the web link we are working on.

Returns:

String

GetWebLinkURL

java.lang.String GetWebLinkURL()

Returns the URL of the web link we are working on.

Returns:

String

GetEditedID

java.lang.String GetEditedID()

Returns the unique identifier for the web link that the user is currently editing (if any). If no link is being edited, the member variable should contain an empty string.

Returns:

String

GetWebLinkCount

int GetWebLinkCount()

Helper method to return the number of links currently cached in the working list

Returns:

int

GetSelectedUsersString

java.lang.String GetSelectedUsersString()

Get the selected users for the tree in the "classid, object format"

Returns:

String

GetSelectedDirItemsAsString

java.lang.String GetSelectedDirItemsAsString()

Get the selected docs and folders for the tree in the "classid, objectid" format

Returns:

String

GetSelectedCommPagesAsString

java.lang.String GetSelectedCommPagesAsString()

Get the selected community pages for the tree in "communityid,pageid;communityid,pageid" format (this is how the comm page tree is set to display the locations)

Returns:

String

IsDirectoryEnabled

boolean IsDirectoryEnabled()

Is the directory enabled for this subportal?

Returns:

boolean

AreCommunitiesEnabled

boolean AreCommunitiesEnabled()

Are communities enabled for this subportal?

Returns:

boolean