com.plumtree.portalpages.common.plugnav
Interface ICommunityPreviewNavPageRO

All Superinterfaces:

IMVCObject, INavigationPageRO

All Known Implementing Classes:

CommunityPreviewNavPage

public interface ICommunityPreviewNavPageRO
extends INavigationPageRO

Community preview page specific functions

Author:

DavidP

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

Method Detail

GetName

java.lang.String GetName()

Unique String Name of category of object. Critical for link blocking by pluggable nav.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in interface INavigationPageRO

Returns:

the name of the object.

See Also:

IMVCObject.GetName()

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 (if in one)

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 -

Returns:

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