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

java.lang.Object
  com.plumtree.portalpages.common.uiparts.navpagetype.NavigationPage
      com.plumtree.portalpages.common.uiparts.navpagetype.CommunityNavPage

All Implemented Interfaces:

ICommunityNavPageRO, INavigationPageRO

public class CommunityNavPage
extends NavigationPage
implements ICommunityNavPageRO

Delegates model methods only usable by community page.

Author:

DavidP

Field Summary

Fields inherited from class com.plumtree.portalpages.common.uiparts.navpagetype.NavigationPage

m_model, m_type

Constructor Summary

CommunityNavPage(INavigationModelRO model)
CommunityNavPage constructor.

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.
ICPListEntryIterator	GetCurCommPages() Gets the current community pages.
int	GetCurCommunityID() Gets the id of the current Community
java.lang.String	GetCurCommunityName() Gets the name of the current Community
int	GetCurPageID() Gets the ID of the current Community Page
ICPListEntryIterator	GetCurRelCommunities() Gets the Communities on the same level as the current community.
ICPListEntryIterator	GetCurSubCommunities() Gets the subcommunities of the current community.
int	GetDefaultCommunity() Get the ID of the user's Default Community ID
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
boolean	IsMemberInCurCommunity() Checks if the current user is a member of the current Community
boolean	ShowCommunityNavigation() Returns true if this page should show the "Inside this Community" header and sub- and related communitites.

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

CommunityNavPage

public CommunityNavPage(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 INavigationPageRO

Overrides:

GetName in class NavigationPage

Returns:

String

See Also:

com.plumtree.uiinfrastructure.activityspace.IMVCObject#GetName()

GetAccessibleCommunityID

public int GetAccessibleCommunityID(int nSubPortalCommID)

Description copied from interface: ICommunityNavPageRO

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 ICommunityNavPageRO

Returns:

int Returns an accessible Community for the current user or -1 if none can be found

See Also:

ICommunityNavPageRO.GetAccessibleCommunityID(int)

GetCurCommunityID

public int GetCurCommunityID()

Description copied from interface: ICommunityNavPageRO

Gets the id of the current Community

Specified by:

GetCurCommunityID in interface ICommunityNavPageRO

Returns:

Object ID of the current Community

See Also:

ICommunityNavPageRO.GetCurCommunityID()

GetCurPageID

public int GetCurPageID()

Gets the ID of the current Community Page

Returns:

Community Page ID

IsMemberInCurCommunity

public boolean IsMemberInCurCommunity()

Checks if the current user is a member of the current Community

Returns:

True if the user is a member

GetCurCommunityName

public java.lang.String GetCurCommunityName()

Description copied from interface: ICommunityNavPageRO

Gets the name of the current Community

Specified by:

GetCurCommunityName in interface ICommunityNavPageRO

Returns:

Name of the current Community

See Also:

ICommunityNavPageRO.GetCurCommunityName()

GetCurCommPages

public ICPListEntryIterator GetCurCommPages()

Gets the current community pages.

Returns:

ICPListEntryIterator

GetCurRelCommunities

public ICPListEntryIterator GetCurRelCommunities()

Description copied from interface: ICommunityNavPageRO

Gets the Communities on the same level as the current community.

Specified by:

GetCurRelCommunities in interface ICommunityNavPageRO

Returns:

Links to the the current community's related communities

See Also:

ICommunityNavPageRO.GetCurRelCommunities()

GetCurSubCommunities

public ICPListEntryIterator GetCurSubCommunities()

Description copied from interface: ICommunityNavPageRO

Gets the subcommunities of the current community.

Specified by:

GetCurSubCommunities in interface ICommunityNavPageRO

Returns:

Links to the subcommunities of the current community

See Also:

ICommunityNavPageRO.GetCurSubCommunities()

GetDefaultCommunity

public int GetDefaultCommunity()

Get the ID of the user's Default Community ID

Specified by:

GetDefaultCommunity in interface ICommunityNavPageRO

Returns:

Object ID of the default Community

GetMyCommunities

public ICPListEntryIterator GetMyCommunities(boolean bListActions)

Description copied from interface: ICommunityNavPageRO

Helper function, returns the join community link, community actions if on a community page and the list of communities.

Specified by:

GetMyCommunities in interface ICommunityNavPageRO

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

See Also:

ICommunityNavPageRO.GetMyCommunities(boolean)

GetParentComm

public ICPListEntryIterator GetParentComm()

Description copied from interface: ICommunityNavPageRO

Gets the parent community of the current Community

Specified by:

GetParentComm in interface ICommunityNavPageRO

Returns:

The link to the parent community of the current Community

See Also:

ICommunityNavPageRO.GetParentComm()

IsCurCommOwner

public boolean IsCurCommOwner()

Description copied from interface: ICommunityNavPageRO

Checks if the current user is the owner of the current Community

Specified by:

IsCurCommOwner in interface ICommunityNavPageRO

Returns:

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

See Also:

ICommunityNavPageRO.IsCurCommOwner()

GetCommunityID

public int GetCommunityID()

Description copied from interface: ICommunityNavPageRO

Get the community ID of the community we are currently viewing.

Specified by:

GetCommunityID in interface ICommunityNavPageRO

Returns:

Object ID of the current Community

See Also:

ICommunityNavPageRO.GetCommunityID()

ShowCommunityNavigation

public boolean ShowCommunityNavigation()

Returns true if this page should show the "Inside this Community" header and sub- and related communitites.

Returns:

true if the page should show community nav links

CanJoinCurCommunity

public boolean CanJoinCurCommunity()

Description copied from interface: ICommunityNavPageRO

Checks if the current user can join the current Community

Specified by:

CanJoinCurCommunity in interface ICommunityNavPageRO

Returns:

True if the current user can join the current Community

See Also:

ICommunityNavPageRO.CanJoinCurCommunity()