com.plumtree.portalpages.common.plugnav
Interface IPluggableNavModelRO

All Superinterfaces:
IModelRO, IMVCObject
All Known Subinterfaces:
INavigationModelRO
All Known Implementing Classes:
NavigationModel

public interface IPluggableNavModelRO
extends IModelRO

This interface offers the pluggable navigation developer all the functionality they need to build pluggable navigation views.

Author:
DavidP

Method Summary
 java.lang.Object Create()
           
 int GetAccessibleCommunityID(int nCommID)
          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 GetCategoryLinks(NavCategoryType linkType, boolean getActions)
          Get the links lists by category, with or without actions
 java.lang.String GetCategoryTitle(NavCategoryType linkType)
          Gets the internationalized string for the title on the category.
 NavPageType GetCurNavPageType()
          Gets the current page type.
 int GetDefaultCommunity()
          Gets a user's defeault community id, (right now the first community in mycommunities)
 NavigationPage GetPageSpecificMethods()
          Used by pluggable navigation to access the model specific to the page we're on (see GetCurNavPage())
 ICPListEntryIterator GetPortalSettings()
          Gets the link to the My Account settings page
 boolean GetSectionVisibility(int nSectionIDConst)
          Gets visibility of the specified vertical navigation section
 HTMLElement GetSubportalBanner()
          Gets the header for this page from the Subportal.
 boolean GetSubPortalEnabled(int nType)
          Checks if the specified feature is enabled in the current subportal.
 HTMLElement GetSubportalFooter()
          Gets the footer for this page from the Subportal.
 java.lang.String GetSubsectionTitle(NavCategoryType linkType, boolean bAction)
          Get the name of the subsection title; basically, actions for mypage and communities only.
 boolean HasAdministratorAccess()
          Checks if the user has admin access rights or not.
 boolean HasSelectAccess()
          Checks if the current user has at least select access to the current Community
 boolean IsEditProfile()
          Checks if the current page is a Edit Default Profile Editor page
 boolean IsGuestSession()
          Checks if logged in as guest or not.
 void SetSectionVisibility(int nSectionIDConst, boolean bShow)
          Sets visibility on vertical navigation sections
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 

Method Detail

Create

java.lang.Object Create()
See Also:
IManagedObject.Create()

GetPortalSettings

ICPListEntryIterator GetPortalSettings()
Gets the link to the My Account settings page

Returns:
Link to My Account settings page in an ICPListEntryIterator

GetSectionVisibility

boolean GetSectionVisibility(int nSectionIDConst)
Gets visibility of the specified vertical navigation section

Parameters:
nSectionIDConst - NavVisibility ID of the section to check visibility on
Returns:
True if the specified section is visibile
See Also:
NavVisibility

GetCategoryTitle

java.lang.String GetCategoryTitle(NavCategoryType linkType)
Gets the internationalized string for the title on the category.

Parameters:
linkType - NavCategoryType
Returns:
Title String for the specified NavCategoryType
See Also:
NavCategoryType

GetSubsectionTitle

java.lang.String GetSubsectionTitle(NavCategoryType linkType,
                                    boolean bAction)
Get the name of the subsection title; basically, actions for mypage and communities only.

Parameters:
linkType - NavCategoryType
boolean - actions true or false
Returns:
String category name for link title
See Also:
NavCategoryType

GetSubportalBanner

HTMLElement GetSubportalBanner()
Gets the header for this page from the Subportal. Returns default header if no header portlet assigned.

Returns:
HTMLElement with the footer set in the Subportal

GetSubportalFooter

HTMLElement GetSubportalFooter()
Gets the footer for this page from the Subportal. Returns default footer if no footer portlet assigned.

Returns:
HTMLElement with the footer set in the Subportal

HasAdministratorAccess

boolean HasAdministratorAccess()
Checks if the user has admin access rights or not.

Returns:
True if the current user has Administrator access to the current Community

HasSelectAccess

boolean HasSelectAccess()
Checks if the current user has at least select access to the current Community

Returns:
boolean
See Also:
com.plumtree.server.PT_ACCESS_LEVELS

IsGuestSession

boolean IsGuestSession()
Checks if logged in as guest or not.

Returns:
true if guest

SetSectionVisibility

void SetSectionVisibility(int nSectionIDConst,
                          boolean bShow)
Sets visibility on vertical navigation sections

Parameters:
nSectionIDConst - NavVisibility ID of the section to set visibility on
bShow - True of the section is visible
See Also:
NavVisibility

GetSubPortalEnabled

boolean GetSubPortalEnabled(int nType)
Checks if the specified feature is enabled in the current subportal.

Parameters:
nType - NavVisibility Section ID
Returns:
boolean True if the specified section is visible
See Also:
NavVisibility

GetPageSpecificMethods

NavigationPage GetPageSpecificMethods()
Used by pluggable navigation to access the model specific to the page we're on (see GetCurNavPage())

Returns:
The current NavigationPage interface
See Also:
NavigationPage, NavPageType

GetCurNavPageType

NavPageType GetCurNavPageType()
Gets the current page type.

Returns:
NavPageType
See Also:
NavPageType

GetDefaultCommunity

int GetDefaultCommunity()
Gets a user's defeault community id, (right now the first community in mycommunities)

Returns:
The default Community ID

GetAccessibleCommunityID

int GetAccessibleCommunityID(int nCommID)
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.

Parameters:
nCommID - 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

GetCategoryLinks

ICPListEntryIterator GetCategoryLinks(NavCategoryType linkType,
                                      boolean getActions)
Get the links lists by category, with or without actions

Parameters:
linkType - NavCategoryType
getActions - True to include actions
Returns:
ICPListEntryIterator with the links of the requested NavCategoryType
See Also:
NavCategoryType

IsEditProfile

boolean IsEditProfile()
Checks if the current page is a Edit Default Profile Editor page

Returns:
boolean



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.