com.plumtree.portalpages.common.uiparts.navpagetype
Class CommunityPreviewNavPage

java.lang.Object
  extended by com.plumtree.portalpages.common.uiparts.navpagetype.NavigationPage
      extended by com.plumtree.portalpages.common.uiparts.navpagetype.CommunityPreviewNavPage
All Implemented Interfaces:
ICommunityPreviewNavPageRO, INavigationPageRO, IMVCObject

public class CommunityPreviewNavPage
extends NavigationPage
implements ICommunityPreviewNavPageRO

Delegates model methods only usable by community preview page.

Author:
DavidP

Field Summary
 
Fields inherited from class com.plumtree.portalpages.common.uiparts.navpagetype.NavigationPage
m_model, m_type
 
Constructor Summary
CommunityPreviewNavPage(INavigationModelRO model)
          CommunityNavPage constructor.
 
Method Summary
 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 GetCurCommunityID()
          Gets the ID of the current Community (if in one)
 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.
 java.lang.String GetName()
          Unique String Name of category of object.
 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 class com.plumtree.portalpages.common.uiparts.navpagetype.NavigationPage
Create, GetPageType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommunityPreviewNavPage

public CommunityPreviewNavPage(INavigationModelRO model)
CommunityNavPage constructor.

Parameters:
model -
Method Detail

GetName

public java.lang.String GetName()
Unique String Name of category of object. Critical for link blocking by pluggable nav.

Specified by:
GetName in interface ICommunityPreviewNavPageRO
Specified by:
GetName in interface INavigationPageRO
Specified by:
GetName in interface IMVCObject
Overrides:
GetName in class NavigationPage
Returns:
String
See Also:
IMVCObject.GetName()

GetAccessibleCommunityID

public int GetAccessibleCommunityID(int nSubPortalCommID)
Description copied from interface: ICommunityPreviewNavPageRO
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.

Specified by:
GetAccessibleCommunityID in interface ICommunityPreviewNavPageRO
Returns:
int Returns an accessible Community for the current user or -1 if none can be found
See Also:
ICommunityPreviewNavPageRO.GetAccessibleCommunityID(int)

GetCurCommunityID

public int GetCurCommunityID()
Description copied from interface: ICommunityPreviewNavPageRO
Gets the ID of the current Community (if in one)

Specified by:
GetCurCommunityID in interface ICommunityPreviewNavPageRO
Returns:
Object ID of the current Community
See Also:
ICommunityPreviewNavPageRO.GetCurCommunityID()

GetCurCommunityName

public java.lang.String GetCurCommunityName()
Description copied from interface: ICommunityPreviewNavPageRO
Gets the name of the current Community

Specified by:
GetCurCommunityName in interface ICommunityPreviewNavPageRO
Returns:
Name of the current Community
See Also:
ICommunityPreviewNavPageRO.GetCurCommunityName()

GetCurRelCommunities

public ICPListEntryIterator GetCurRelCommunities()
Description copied from interface: ICommunityPreviewNavPageRO
Gets the Communities on the same level as the current community.

Specified by:
GetCurRelCommunities in interface ICommunityPreviewNavPageRO
Returns:
Links to the the current community's related communities
See Also:
ICommunityPreviewNavPageRO.GetCurRelCommunities()

GetCurSubCommunities

public ICPListEntryIterator GetCurSubCommunities()
Description copied from interface: ICommunityPreviewNavPageRO
Gets the subcommunities of the current community.

Specified by:
GetCurSubCommunities in interface ICommunityPreviewNavPageRO
Returns:
Links to the subcommunities of the current community
See Also:
ICommunityPreviewNavPageRO.GetCurSubCommunities()

GetDefaultCommunity

public int GetDefaultCommunity()
Description copied from interface: ICommunityPreviewNavPageRO
Gets the default Community ID of the current user, i.e. first Community in the membership list.

Specified by:
GetDefaultCommunity in interface ICommunityPreviewNavPageRO
Returns:
Object ID of the default Community
See Also:
ICommunityPreviewNavPageRO.GetDefaultCommunity()

GetMyCommunities

public ICPListEntryIterator GetMyCommunities(boolean bListActions)
Description copied from interface: ICommunityPreviewNavPageRO
Helper function, returns the join community link, community actions if on a community page and the list of communities.

Specified by:
GetMyCommunities in interface ICommunityPreviewNavPageRO
Returns:
ICPListEntryIterator
See Also:
ICommunityPreviewNavPageRO.GetMyCommunities(boolean)

GetParentComm

public ICPListEntryIterator GetParentComm()
Description copied from interface: ICommunityPreviewNavPageRO
Gets the parent community of the current Community

Specified by:
GetParentComm in interface ICommunityPreviewNavPageRO
Returns:
The link to the parent community of the current Community
See Also:
ICommunityPreviewNavPageRO.GetParentComm()

IsCurCommOwner

public boolean IsCurCommOwner()
Description copied from interface: ICommunityPreviewNavPageRO
Checks if the current user is the owner of the current Community

Specified by:
IsCurCommOwner in interface ICommunityPreviewNavPageRO
Returns:
True if the current user is the owner of the current Community
See Also:
ICommunityPreviewNavPageRO.IsCurCommOwner()



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