com.plumtree.portalpages.common.plugnav
Interface ICommunityNavPageRO

All Superinterfaces:
INavigationPageRO
All Known Implementing Classes:
CommunityNavPage

public interface ICommunityNavPageRO
extends INavigationPageRO

Delegates model methods only usable by community page.

Author:
DavidP

Method Summary
 boolean CanJoinCurCommunity()
          Checks if the current user can join the current Community
 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.
 int GetCommunityID()
          Get the community ID of the community we are currently viewing.
 int GetCurCommunityID()
          Gets the id of the current Community
 java.lang.String GetCurCommunityName()
          Gets the name of the current Community
 ICPListEntryIterator GetCurRelCommunities()
          Gets the Communities on the same level as the current community.
 ICPListEntryIterator GetCurSubCommunities()
          Gets the subcommunities of the current community.
 int GetDefaultCommunity()
          Gets the default Community ID of the current user, i.e.
 ICPListEntryIterator GetMyCommunities(boolean bListActions)
          Helper function, returns the join community link, community actions if on a community page and the list of communities.
 ICPListEntryIterator GetParentComm()
          Gets the parent community of the current Community
 boolean IsCurCommOwner()
          Checks if the current user is the owner of the current Community
 
Methods inherited from interface com.plumtree.portalpages.common.plugnav.INavigationPageRO
GetName
 

Method Detail

GetAccessibleCommunityID

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.

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

GetCurCommunityID

int GetCurCommunityID()
Gets the id of the current Community

Returns:
Object ID of the current Community

GetCurCommunityName

java.lang.String GetCurCommunityName()
Gets the name of the current Community

Returns:
Name of the current Community

GetCurRelCommunities

ICPListEntryIterator GetCurRelCommunities()
Gets the Communities on the same level as the current community.

Returns:
Links to the the current community's related communities

GetCurSubCommunities

ICPListEntryIterator GetCurSubCommunities()
Gets the subcommunities of the current community.

Returns:
Links to the subcommunities of the current community

GetDefaultCommunity

int GetDefaultCommunity()
Gets the default Community ID of the current user, i.e. first Community in the membership list.

Returns:
Object ID of the default Community

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

GetParentComm

ICPListEntryIterator GetParentComm()
Gets the parent community of the current Community

Returns:
The link to the parent community of the current Community

IsCurCommOwner

boolean IsCurCommOwner()
Checks if the current user is the owner of the current Community

Returns:
True if the current user is the owner of the current Community

GetCommunityID

int GetCommunityID()
Get the community ID of the community we are currently viewing.

Returns:
Object ID of the current Community

CanJoinCurCommunity

boolean CanJoinCurCommunity()
Checks if the current user can join the current Community

Returns:
True if the current user can join the current Community



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