|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface INavigationModelRO
Navigation model interface for MVC and pluggable navigation.
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 |
---|
java.lang.Object Create()
Create
in interface IPluggableNavModelRO
com.plumtree.uiinfrastructure.activityspace.IManagedObject#Create()
int GetAccessibleCommunityID(int nSubPortalCommID)
IPluggableNavModelRO
GetAccessibleCommunityID
in interface IPluggableNavModelRO
nSubPortalCommID
- ID of the Community to check access to
IPluggableNavModelRO.GetAccessibleCommunityID(int)
ICPListEntryIterator GetAdminLink()
ICPListEntryIterator GetCommunityActions()
com.plumtree.xpshared.browsing.myportal.IMyPortalModelHelper#GetMyPortalActions(int,
int)
ICPListEntryIterator GetCurCommPages()
int GetCurCommunityID()
java.lang.String GetCurCommunityName()
int GetCurDocDirFolderID()
ICPListEntryIterator GetCurMandatoryTabs(boolean bAddAdminLink)
bAddAdminLink
- Include Admin link in the list
ICPListEntryIterator GetCurMyPages(boolean bShowActions)
bShowActions
- Include Mypage actions
int GetCurPageID()
java.lang.String GetCurPageName()
ICPListEntryIterator GetCurRelCommunities()
ICPListEntryIterator GetCurSubCommunities()
int GetDefaultCommunity()
GetDefaultCommunity
in interface IPluggableNavModelRO
ASURL GetDefaultSubportalURL()
ICPListEntryIterator GetDirectoryLinks()
HTMLElementCollection GetFooterElement()
boolean GetFooterHasBeenSet()
boolean GetHeaderHasBeenSet()
HTMLElementCollection GetHeaderElement()
java.lang.String GetGreeting()
ICPListEntryIterator GetMandatoryLinks()
java.lang.String GetMandatoryLinksFolderName()
ICPListEntryIterator GetMyCommunities(boolean bListActions)
bListActions
- True to return the community actions in the list, false otherwise
ICPListEntryIterator GetMyPageActions()
com.plumtree.xpshared.browsing.myportal.IMyPortalModelHelper#GetMyPagesActions()
java.lang.String GetName()
com.plumtree.xpshared.activityspace.IModelRO#GetName()
ICPListEntryIterator GetParentComm()
ICPListEntryIterator GetPortalSettings()
GetPortalSettings
in interface IPluggableNavModelRO
boolean GetSectionVisibility(int nSectionIDConst)
GetSectionVisibility
in interface IPluggableNavModelRO
nSectionIDConst
- Navigation section ID (defined in NavVisibility
NavVisibility
boolean GetSubPortalEnabled(int nType)
GetSubPortalEnabled
in interface IPluggableNavModelRO
nType
- Feature type defined in PT_SUBPORTAL_ACCESS_TYPES
NavVisibility
int GetSubPortalFirstPageType()
int GetSubPortalNavScheme()
int GetSubPortalPageID()
HTMLElement GetSubportalBanner()
GetSubportalBanner
in interface IPluggableNavModelRO
HTMLElement GetSubportalFooter()
GetSubportalFooter
in interface IPluggableNavModelRO
java.lang.String GetSubtitleForBanner()
java.lang.String GetTitleForBanner()
boolean HasAdministratorAccess()
HasAdministratorAccess
in interface IPluggableNavModelRO
boolean HasSelectAccess()
HasSelectAccess
in interface IPluggableNavModelRO
com.plumtree.server.PT_ACCESS_LEVELS
boolean IsCommunityPage()
boolean IsCurCommOwner()
boolean IsDirPage()
boolean IsGuestSession()
IsGuestSession
in interface IPluggableNavModelRO
boolean IsMemberInCurCommunity()
boolean IsLoginPage()
boolean IsMyPage()
void SetFooterElement(boolean bClearPrevContent, HTMLElement element)
bClearPrevContent
- True to clear any previously set footerelement
- The new footer elementvoid SetHeaderElement(boolean bClearPrevContent, HTMLElement element)
bClearPrevContent
- True to clear any previously set headerelement
- The new header element
HTMLException
void SetSectionVisibility(int nSectionIDConst, boolean bShow)
SetSectionVisibility
in interface IPluggableNavModelRO
nSectionIDConst
- Section ID defined in NavVisibilitybShow
- true if the section is displayed, false otherwiseNavVisibility
boolean IsPreviewPage()
IModel GetMyPortalModel()
boolean ShowCommunityNavigation()
boolean CanJoinCurCommunity()
int GetRegisteredViewNavScheme()
void SetRegisteredViewNavScheme(int newNavScheme)
the
- new registered view's Nav Scheme
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |