Plumtree Pluggable Navigation API  
 

NavigationModel Members

NavigationModel overview

Public Static Fields

iconiconFOLDERID_UNCHANGED Directory constants
iconiconLOGIN_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?
iconiconNO_CURRENT_COMMID Uninitialized Community ID value
iconiconNO_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.
iconiconPROPIDTYPE_INT Add more when neccessary *
iconiconPROPIDTYPE_STRING 
iconiconSTR_MVC_CLASS_NAME Navigation model class identifier for activty space registration

Public Static Methods

iconiconSortQueryResult Creates a PTSortedArrayWrapper from a queryresult

Protected Static Fields

iconiconNAV_SECTIONVISARRAY_PREFSNAME Personal preference name of the vertical navigation section visibility setting
iconiconSECTION_VISIBILITY_SESSION_ATTRIBUTE Session attribute name of the array holding section visibility flag

Public Instance Constructors

icon NavigationModel Constructor Initializes a new instance of the NavigationModel class.

Public Instance Methods

iconCalculateCurCommunityID Find the current Community ID
iconCanJoinCurCommunity 
iconCleanupAllData (inherited from com.plumtree.uiinfrastructure.activityspace.AClearModel) 
iconCleanupTempData (inherited from com.plumtree.uiinfrastructure.activityspace.AClearModel) 
iconConvertCommunityPagePTURLListToICPIterator Helper to convert an XPArrayList with IPTURLs to Community or Communitypages to an ICPListEntryIterator
iconConvertMyPagePTURLListToICPIterator Helper to convert an XPArrayList with IPTURLs to MyPages to an ICPListEntryIterator
iconCreate 
iconEquals (inherited from Object)Determines whether the specified Object is equal to the current Object.
iconGetAccessibleCommunityID 
iconGetAdminLink Form the admin link for navigation
iconGetCategoryLinks 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.
iconGetCategoryTitle Get the name of the category link type. Example: "Administrator" for admin. Top level only.
iconGetCommunityActions 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.
iconGetCurCommPages Gets all the current community pages if on community page
iconGetCurCommunityID 
iconGetCurCommunityName Gets the name of the current Community (if in one) from the MyPortalModel. NOTE: Returned string not HTMLEncoded
iconGetCurDocDirFolderID Gets the id of the current document directory folder, or 0 if we are not currently in a single doc directory folder.
iconGetCurMandatoryTabs 
iconGetCurMyPages Gets all the current my pages if on the my page
iconGetCurMyPagesResult 
iconGetCurNavPageType 
iconGetCurPageID gets the current mypage id
iconGetCurPageName NOTE: Returned string not HTML/URLEncoded.
iconGetCurRelCommunities Get the current related communtiies links
iconGetCurSubCommunities Get current subcommunities links
iconGetDefaultCommunity 
iconGetDefaultCommunityPassSubportal 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.
iconGetDefaultSubportalURL 
iconGetDirectoryLinks Get list of directory links
iconGetFooterElement Get footer element
iconGetFooterHasBeenSet 
iconGetGreeting Get "welcome" greeting string
iconGetHashCode (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.
iconGetHeaderElement 
iconGetHeaderHasBeenSet 
iconGetIntrinsicPortletContentWithErrorHandling 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.
iconGetMandatoryLinks Get the list fo mandatory links
iconGetMandatoryLinksFolderName 
iconGetMyCommunities Helper function, returns the join community link, community actions if on a community page and the list of communities.
iconGetMyHome Returns the My Home link for the current user (the page the user first sees after logging in.
iconGetMyPageActions Get actions list for th eMyPages links.
iconGetMyPortalModel Used by pluggable navigation to access the MyPages model
iconGetName 
iconGetNewTempData 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.
iconGetPageSpecificMethods 
iconGetParentComm NAVIGATION LINK GENERATION ***************************************************** /**
iconGetPortalSettings 
iconGetRegisteredViewNavScheme Gets the currently registered view's Nav Scheme
iconGetSectionVisibility 
iconGetSubportalBanner 
iconGetSubPortalEnabled 
iconGetSubPortalEnabledPassSubportal Checks if the specified access type is enabled on the current user's subportal.
iconGetSubPortalFirstPageType 
iconGetSubportalFooter 
iconGetSubPortalNavScheme 
iconGetSubPortalPageID 
iconGetSubsectionTitle Get the name of the subsection title; basically, actions for mypage and communities only.
iconGetSubtitleForBanner 
iconGetTitleForBanner 
iconGetType (inherited from Object)Gets the Type of the current instance.
iconHasAdministratorAccess 
iconHasAdminLinkAccess Checks to see if we should display the admin link or not
iconHasSelectAccess 
iconInit 
iconInitializePortletContent 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.
iconIsCommunityPage 
iconIsCurCommOwner 
iconIsDefaultProfile 
iconIsDirPage 
iconIsEditProfile 
iconIsGuestSession 
iconIsLoginPage 
iconIsMemberInCurCommunity 
iconIsMyPage 
iconIsMyPortalPage Checks if this a MyPortal page, (either Mypage or Community page
iconIsPreviewPage This function checks the MyPortalModel to see if the current page is a community preview page (certain actions are disabled in this case).
iconIsUserProfileCommunity Checks if this is the User Profile Community
iconReInit To be called by AActivitySpace ReInit()
iconSetFooterElement 
iconSetHeaderElement 
iconSetRegisteredViewNavScheme Sets the currently registered view nav scheme to be newNavScheme
iconSetSectionVisibility 
iconShowCommunityNavigation 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.
iconToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

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

See Also

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