Plumtree Pluggable Navigation API  
 

NavigationModel Members

NavigationModel overview

Public Static Fields

FOLDERID_UNCHANGED Directory constants
LOGIN_TOKEN_LIFE_SPAN How long the login token passed with the admin link should be valid for, don't want too long since it compromises security but too short could invalidate it before the user clicks on the link, measured in minutes. Maybe worth to put as a setting in config.xml?
NO_CURRENT_COMMID Uninitialized Community ID value
NO_CURRENT_PAGEID Uninitialized Mypage ID value. Not -1 since that is the home page for administrator Set to 0 since it is passed and used to open the myportalobject in the appdataobject and 0 represents the user's default homepage.
PROPIDTYPE_INT Add more when neccessary *
PROPIDTYPE_STRING 
STR_MVC_CLASS_NAME Navigation model class identifier for activty space registration

Public Static Methods

SortQueryResult Creates a PTSortedArrayWrapper from a queryresult

Protected Static Fields

NAV_SECTIONVISARRAY_PREFSNAME Personal preference name of the vertical navigation section visibility setting
SECTION_VISIBILITY_SESSION_ATTRIBUTE Session attribute name of the array holding section visibility flag

Public Instance Constructors

NavigationModel Constructor Initializes a new instance of the NavigationModel class.

Public Instance Methods

CalculateCurCommunityID Find the current Community ID
CanJoinCurCommunity 
CleanupAllData (inherited from com.plumtree.uiinfrastructure.activityspace.AClearModel) 
CleanupTempData (inherited from com.plumtree.uiinfrastructure.activityspace.AClearModel) 
ConvertCommunityPagePTURLListToICPIterator Helper to convert an XPArrayList with IPTURLs to Community or Communitypages to an ICPListEntryIterator
ConvertMyPagePTURLListToICPIterator Helper to convert an XPArrayList with IPTURLs to MyPages to an ICPListEntryIterator
Create 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetAccessibleCommunityID 
GetAdminLink Form the admin link for navigation
GetCategoryLinks Get the links lists by category, with or without actions. If getActions is true, returns *only actions*, else returns *only the list*. Note that subportal access is also tested, so if community access is disabled on the subportal the links list will be null.
GetCategoryTitle Get the name of the category link type. Example: "Administrator" for admin. Top level only.
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. NOTE: Any logic changes in this function also needs to be added to TaskAPIUICommunity functions.
GetCurCommPages Gets all the current community pages if on community page
GetCurCommunityID 
GetCurCommunityName Gets the name of the current Community (if in one) from the MyPortalModel. NOTE: Returned string not HTMLEncoded
GetCurDocDirFolderID Gets the id of the current document directory folder, or 0 if we are not currently in a single doc directory folder.
GetCurMandatoryTabs 
GetCurMyPages Gets all the current my pages if on the my page
GetCurMyPagesResult 
GetCurNavPageType 
GetCurPageID gets the current mypage id
GetCurPageName NOTE: Returned string not HTML/URLEncoded.
GetCurRelCommunities Get the current related communtiies links
GetCurSubCommunities Get current subcommunities links
GetDefaultCommunity 
GetDefaultCommunityPassSubportal Get the default Community ID - the ID set in PTConfig.xml or if that is zero, then the ID of the first community in a user's membership list.
GetDefaultSubportalURL 
GetDirectoryLinks Get list of directory links
GetFooterElement Get footer element
GetFooterHasBeenSet 
GetGreeting Get "welcome" greeting string
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetHeaderElement 
GetHeaderHasBeenSet 
GetIntrinsicPortletContentWithErrorHandling Gets the content for an intrinsic portlet, or generates properly beautified error results Used only for headers and footers, and *only* used in NavigationModel and MyPortalModel - not for standard usage, although it will work well enough for those cases.
GetMandatoryLinks Get the list fo mandatory links
GetMandatoryLinksFolderName 
GetMyCommunities Helper function, returns the join community link, community actions if on a community page and the list of communities.
GetMyHome Returns the My Home link for the current user (the page the user first sees after logging in.
GetMyPageActions Get actions list for th eMyPages links.
GetMyPortalModel Used by pluggable navigation to access the MyPages model
GetName 
GetNewTempData 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.
GetPageSpecificMethods 
GetParentComm NAVIGATION LINK GENERATION ***************************************************** /**
GetPortalSettings 
GetRegisteredViewNavScheme Gets the currently registered view's Nav Scheme
GetSectionVisibility 
GetSubportalBanner 
GetSubPortalEnabled 
GetSubPortalEnabledPassSubportal Checks if the specified access type is enabled on the current user's subportal.
GetSubPortalFirstPageType 
GetSubportalFooter 
GetSubPortalNavScheme 
GetSubPortalPageID 
GetSubsectionTitle Get the name of the subsection title; basically, actions for mypage and communities only.
GetSubtitleForBanner 
GetTitleForBanner 
GetType (inherited from Object)Gets the Type of the current instance.
HasAdministratorAccess 
HasAdminLinkAccess Checks to see if we should display the admin link or not
HasSelectAccess 
Init 
InitializePortletContent Sets up all the portlet content for this page. Whether it is a communiy page, my page, or otherwise. It should only be called after the Expression Engine has been run to determine what the subportal is.
IsCommunityPage 
IsCurCommOwner 
IsDefaultProfile 
IsDirPage 
IsEditProfile 
IsGuestSession 
IsLoginPage 
IsMemberInCurCommunity 
IsMyPage 
IsMyPortalPage Checks if this a MyPortal page, (either Mypage or Community page
IsPreviewPage This function checks the MyPortalModel to see if the current page is a community preview page (certain actions are disabled in this case).
IsUserProfileCommunity Checks if this is the User Profile Community
ReInit To be called by AActivitySpace ReInit()
SetFooterElement 
SetHeaderElement 
SetRegisteredViewNavScheme Sets the currently registered view nav scheme to be newNavScheme
SetSectionVisibility 
ShowCommunityNavigation Returns true if this page should show the "Inside this Community" header and sub- and related communitites. Should be true for all pages except the user profile community.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetTempData (inherited from com.plumtree.uiinfrastructure.activityspace.AClearModel) 
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

NavigationModel Class | com.plumtree.portalpages.common.uiparts Namespace