com.plumtree.portalpages.common.uiparts
Interface INavigationModelRO

All Superinterfaces:

IPluggableNavModelRO

All Known Implementing Classes:

NavigationModel

public interface INavigationModelRO
extends IPluggableNavModelRO

Navigation model interface for MVC and pluggable navigation.

Author:

RobZ, DavidP

Method Summary

boolean	CanJoinCurCommunity() Checks if the current user can join the current Community
java.lang.Object	Create()
int	GetAccessibleCommunityID(int nSubPortalCommID) Checks for at least read access to the specified Community, If current user lacks access, get the user's default Community and user has no default communities, return -1.
ICPListEntryIterator	GetAdminLink() Gets the link to Administration
ICPListEntryIterator	GetCommunityActions() Never check IsCommunityPage before calling this function.
ICPListEntryIterator	GetCurCommPages() Gets the Community Pages from the current Community
int	GetCurCommunityID() Gets the ID of the current Community (if in one)
java.lang.String	GetCurCommunityName() Gets the name of the current Community (if in one)
int	GetCurDocDirFolderID() Gets the id of the current document directory folder, or 0 if we are not currently in a single doc directory folder.
ICPListEntryIterator	GetCurMandatoryTabs(boolean bAddAdminLink) Get the Mandatory Tabs for the current user
ICPListEntryIterator	GetCurMyPages(boolean bShowActions) Gets the Mypages for the current user
int	GetCurPageID() Gets the current page ID, either Mypage or Community
java.lang.String	GetCurPageName() Gets the current page name
ICPListEntryIterator	GetCurRelCommunities() Get the related communities of the current community
ICPListEntryIterator	GetCurSubCommunities() Gets the subcommunities of the current community
int	GetDefaultCommunity() Gets the default community ID of the current user
ASURL	GetDefaultSubportalURL() Gets the URL to the default subportal of the current user
ICPListEntryIterator	GetDirectoryLinks() Get the directory links
HTMLElementCollection	GetFooterElement() Get footer element
boolean	GetFooterHasBeenSet() Checks if a footer has been set for the current page
java.lang.String	GetGreeting() Gets the greeting for the current user
HTMLElementCollection	GetHeaderElement() Get header element
boolean	GetHeaderHasBeenSet() Checks if a header has been set for the current page
ICPListEntryIterator	GetMandatoryLinks() Gets the mandatory links for the current user
java.lang.String	GetMandatoryLinksFolderName() Gets the name for the mandatory links folder for the current user
ICPListEntryIterator	GetMyCommunities(boolean bListActions) Helper function, returns the join community link, community actions if on a community page and the list of communities.
ICPListEntryIterator	GetMyPageActions() Get the mypage actions for the current page and user
IModel	GetMyPortalModel() Used by pluggable navigation to access the MyPages model
java.lang.String	GetName()
ICPListEntryIterator	GetParentComm() Gets the parent community for the current community.
ICPListEntryIterator	GetPortalSettings() Gets the link to the user's My Account page (user portal preferences)
int	GetRegisteredViewNavScheme() Sets the currently registered view nav scheme to be newNavScheme
boolean	GetSectionVisibility(int nSectionIDConst) Gets the current visibility status of the specified section.
HTMLElement	GetSubportalBanner() Gets the Banner set in the subportal
boolean	GetSubPortalEnabled(int nType) Checks if the specified feature is enabled for current user's subportal
int	GetSubPortalFirstPageType() Gets the page type of the current user's default my home page-type.
HTMLElement	GetSubportalFooter() Gets the footer set in the subportal
int	GetSubPortalNavScheme() Gets the navigation scheme set for the current user
int	GetSubPortalPageID() Gets the Page ID of the first page a user should see after logging in.
java.lang.String	GetSubtitleForBanner() Gets the subtitle of the current page
java.lang.String	GetTitleForBanner() Gets the title of the current page
boolean	HasAdministratorAccess() Checks if the current user has Administrator access
boolean	HasSelectAccess() Checks if the current user has select access to the current community
boolean	IsCommunityPage() Checks if the current page is a Community Page
boolean	IsCurCommOwner() Checks if the current user is the owner of the current Community
boolean	IsDirPage() Checks if the current page is a directory page
boolean	IsGuestSession() Checks if the current user is the Guest user
boolean	IsLoginPage() Checks if the current page is the login page
boolean	IsMemberInCurCommunity() Checks if the current user is a member of the current Community
boolean	IsMyPage() Checks if the current page is a mypage
boolean	IsPreviewPage() This function checks the MyPortalModel to see if the current page is a community preview page (certain actions are disabled in this case).
void	SetFooterElement(boolean bClearPrevContent, HTMLElement element) Sets a new footer element
void	SetHeaderElement(boolean bClearPrevContent, HTMLElement element) Sets a new header element.
void	SetRegisteredViewNavScheme(int newNavScheme) Sets the currently registered view nav scheme to be newNavScheme
void	SetSectionVisibility(int nSectionIDConst, boolean bShow) Set the visibility of the specified Navigation section.
boolean	ShowCommunityNavigation() Returns true if this page should show the "Inside this Community" header and sub- and related communitites.

Methods inherited from interface com.plumtree.portalpages.common.plugnav.IPluggableNavModelRO

GetCategoryLinks, GetCategoryTitle, GetCurNavPageType, GetPageSpecificMethods, GetSubsectionTitle, IsEditProfile

Method Detail

Create

java.lang.Object Create()

Specified by:

Create in interface IPluggableNavModelRO

See Also:

com.plumtree.uiinfrastructure.activityspace.IManagedObject#Create()

GetAccessibleCommunityID

int GetAccessibleCommunityID(int nSubPortalCommID)

Description copied from interface: IPluggableNavModelRO

Checks for at least read access to the specified Community, If current user lacks access, get the user's default Community and user has no default communities, return -1.

Specified by:

GetAccessibleCommunityID in interface IPluggableNavModelRO

Parameters:

nSubPortalCommID - ID of the Community to check access to

Returns:

int Returns an accessible Community for the current user or -1 if none can be found

See Also:

IPluggableNavModelRO.GetAccessibleCommunityID(int)

GetAdminLink

ICPListEntryIterator GetAdminLink()

Gets the link to Administration

Returns:

ICPListEntryIterator

GetCommunityActions

ICPListEntryIterator GetCommunityActions()

Never check IsCommunityPage before calling this function. Has internal security check and need to display the edit community membership entry even when not on community pages.

See Also:

com.plumtree.xpshared.browsing.myportal.IMyPortalModelHelper#GetMyPortalActions(int, int)

GetCurCommPages

ICPListEntryIterator GetCurCommPages()

Gets the Community Pages from the current Community

Returns:

ICPListEntryIterator containing current Community Pages

GetCurCommunityID

int GetCurCommunityID()

Gets the ID of the current Community (if in one)

Returns:

Object ID of the current Community

GetCurCommunityName

java.lang.String GetCurCommunityName()

Gets the name of the current Community (if in one)

Returns:

Name of the current Community

GetCurDocDirFolderID

int GetCurDocDirFolderID()

Gets the id of the current document directory folder, or 0 if we are not currently in a single doc directory folder.

Returns:

Current Document Directory Folder ID, 0 if not in the Document Directory

GetCurMandatoryTabs

ICPListEntryIterator GetCurMandatoryTabs(boolean bAddAdminLink)

Get the Mandatory Tabs for the current user

Parameters:

bAddAdminLink - Include Admin link in the list

Returns:

ICPListEntryIterator containing Mandatory Community tabs

GetCurMyPages

ICPListEntryIterator GetCurMyPages(boolean bShowActions)

Gets the Mypages for the current user

Parameters:

bShowActions - Include Mypage actions

Returns:

ICPListEntryIterator with Mypages

GetCurPageID

int GetCurPageID()

Gets the current page ID, either Mypage or Community

Returns:

Current Mypage or Community page ID

GetCurPageName

java.lang.String GetCurPageName()

Gets the current page name

Returns:

Page Name

GetCurRelCommunities

ICPListEntryIterator GetCurRelCommunities()

Get the related communities of the current community

Returns:

ICPListEntryIterator

GetCurSubCommunities

ICPListEntryIterator GetCurSubCommunities()

Gets the subcommunities of the current community

Returns:

ICPListEntryIterator

GetDefaultCommunity

int GetDefaultCommunity()

Gets the default community ID of the current user

Specified by:

GetDefaultCommunity in interface IPluggableNavModelRO

Returns:

GetDefaultSubportalURL

ASURL GetDefaultSubportalURL()

Gets the URL to the default subportal of the current user

Returns:

GetDirectoryLinks

ICPListEntryIterator GetDirectoryLinks()

Get the directory links

Returns:

ICPListEntryIterator

GetFooterElement

HTMLElementCollection GetFooterElement()

Get footer element

Returns:

HTMLElementCollection

GetFooterHasBeenSet

boolean GetFooterHasBeenSet()

Checks if a footer has been set for the current page

Returns:

True if a footer has been set

GetHeaderHasBeenSet

boolean GetHeaderHasBeenSet()

Checks if a header has been set for the current page

Returns:

True if a header has been set

GetHeaderElement

HTMLElementCollection GetHeaderElement()

Get header element

Returns:

HTMLElementCollection

GetGreeting

java.lang.String GetGreeting()

Gets the greeting for the current user

Returns:

String greeting

GetMandatoryLinks

ICPListEntryIterator GetMandatoryLinks()

Gets the mandatory links for the current user

Returns:

Mandatory links ICPListEntryIterator

GetMandatoryLinksFolderName

java.lang.String GetMandatoryLinksFolderName()

Gets the name for the mandatory links folder for the current user

Returns:

Mandatory folder String name

GetMyCommunities

ICPListEntryIterator GetMyCommunities(boolean bListActions)

Helper function, returns the join community link, community actions if on a community page and the list of communities.

Parameters:

bListActions - True to return the community actions in the list, false otherwise

Returns:

Communities the current user is a member of in a ICPListEntryIterator

GetMyPageActions

ICPListEntryIterator GetMyPageActions()

Get the mypage actions for the current page and user

Returns:

An XPArrayList with ASURLContainer objects.

See Also:

com.plumtree.xpshared.browsing.myportal.IMyPortalModelHelper#GetMyPagesActions()

GetName

java.lang.String GetName()

See Also:

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

GetParentComm

ICPListEntryIterator GetParentComm()

Gets the parent community for the current community. The list will only contain one item.

Returns:

Parent community

GetPortalSettings

ICPListEntryIterator GetPortalSettings()

Gets the link to the user's My Account page (user portal preferences)

Specified by:

GetPortalSettings in interface IPluggableNavModelRO

Returns:

Personal preference link in an ICPListEntryIterator

GetSectionVisibility

boolean GetSectionVisibility(int nSectionIDConst)

Gets the current visibility status of the specified section. Use constants defined in com.plumtree.portalpages.common.uiparts.navpagetype.NavVisibility.

Specified by:

GetSectionVisibility in interface IPluggableNavModelRO

Parameters:

nSectionIDConst - Navigation section ID (defined in NavVisibility

Returns:

boolean Section visible or not

See Also:

NavVisibility

GetSubPortalEnabled

boolean GetSubPortalEnabled(int nType)

Checks if the specified feature is enabled for current user's subportal

Specified by:

GetSubPortalEnabled in interface IPluggableNavModelRO

Parameters:

nType - Feature type defined in PT_SUBPORTAL_ACCESS_TYPES

Returns:

Feature enabled or not

See Also:

NavVisibility

GetSubPortalFirstPageType

int GetSubPortalFirstPageType()

Gets the page type of the current user's default my home page-type.

Returns:

int Page type, -1 one if none can be found.

GetSubPortalNavScheme

int GetSubPortalNavScheme()

Gets the navigation scheme set for the current user

Returns:

Navigation scheme ID

GetSubPortalPageID

int GetSubPortalPageID()

Gets the Page ID of the first page a user should see after logging in. Set on a user's Subportal

Returns:

Page ID of the first page a user is redirected to after logging in

GetSubportalBanner

HTMLElement GetSubportalBanner()

Gets the Banner set in the subportal

Specified by:

GetSubportalBanner in interface IPluggableNavModelRO

Returns:

Banner HTMLElement

GetSubportalFooter

HTMLElement GetSubportalFooter()

Gets the footer set in the subportal

Specified by:

GetSubportalFooter in interface IPluggableNavModelRO

Returns:

Footer HTMLElement

GetSubtitleForBanner

java.lang.String GetSubtitleForBanner()

Gets the subtitle of the current page

Returns:

Page Subtitle String

GetTitleForBanner

java.lang.String GetTitleForBanner()

Gets the title of the current page

Returns:

Page title String

HasAdministratorAccess

boolean HasAdministratorAccess()

Checks if the current user has Administrator access

Specified by:

HasAdministratorAccess in interface IPluggableNavModelRO

Returns:

boolean

HasSelectAccess

boolean HasSelectAccess()

Checks if the current user has select access to the current community

Specified by:

HasSelectAccess in interface IPluggableNavModelRO

Returns:

boolean

See Also:

com.plumtree.server.PT_ACCESS_LEVELS

IsCommunityPage

boolean IsCommunityPage()

Checks if the current page is a Community Page

Returns:

boolean

IsCurCommOwner

boolean IsCurCommOwner()

Checks if the current user is the owner of the current Community

Returns:

boolean

IsDirPage

boolean IsDirPage()

Checks if the current page is a directory page

Returns:

boolean

IsGuestSession

boolean IsGuestSession()

Checks if the current user is the Guest user

Specified by:

IsGuestSession in interface IPluggableNavModelRO

Returns:

boolean

IsMemberInCurCommunity

boolean IsMemberInCurCommunity()

Checks if the current user is a member of the current Community

Returns:

boolean

IsLoginPage

boolean IsLoginPage()

Checks if the current page is the login page

Returns:

boolean

IsMyPage

boolean IsMyPage()

Checks if the current page is a mypage

Returns:

boolean

SetFooterElement

void SetFooterElement(boolean bClearPrevContent,
                      HTMLElement element)

Sets a new footer element

Parameters:

bClearPrevContent - True to clear any previously set footer

element - The new footer element

SetHeaderElement

void SetHeaderElement(boolean bClearPrevContent,
                      HTMLElement element)

Sets a new header element.

Parameters:

bClearPrevContent - True to clear any previously set header

element - The new header element

Throws:

HTMLException

SetSectionVisibility

void SetSectionVisibility(int nSectionIDConst,
                          boolean bShow)

Set the visibility of the specified Navigation section.

Specified by:

SetSectionVisibility in interface IPluggableNavModelRO

Parameters:

nSectionIDConst - Section ID defined in NavVisibility

bShow - true if the section is displayed, false otherwise

See Also:

NavVisibility

IsPreviewPage

boolean IsPreviewPage()

This function checks the MyPortalModel to see if the current page is a community preview page (certain actions are disabled in this case).

Returns:

boolean

GetMyPortalModel

IModel GetMyPortalModel()

Used by pluggable navigation to access the MyPages model

Returns:

The MyPortal IModel interface

ShowCommunityNavigation

boolean ShowCommunityNavigation()

Returns true if this page should show the "Inside this Community" header and sub- and related communitites.

Returns:

true if the page should show community nav links

CanJoinCurCommunity

boolean CanJoinCurCommunity()

Checks if the current user can join the current Community

Returns:

boolean

GetRegisteredViewNavScheme

int GetRegisteredViewNavScheme()

Sets the currently registered view nav scheme to be newNavScheme

Returns:

Currently registered Navigation Scheme.

SetRegisteredViewNavScheme

void SetRegisteredViewNavScheme(int newNavScheme)

Sets the currently registered view nav scheme to be newNavScheme

Parameters:

the - new registered view's Nav Scheme