com.plumtree.remote.prc
Interface ICommunityManager

All Superinterfaces:

IObjectManager

public interface ICommunityManager

extends IObjectManager

Interface that provides remote access to communities.

Method Summary

IObjectQuery	getCommunityPages(int communityID) Queries the community pages and their properties for a given community.
int	getCommunityParentId(int communityID) Gets the parent ID of given community.
IObjectQuery	getSubCommunities(int communityID) Queries the sub communities for a given community.
boolean	isSubCommunitiesPresent(int communityID) Queries and returns true if there are one or more sub communities for a given community, else the returned value is false.

Methods inherited from interface com.plumtree.remote.prc.IObjectManager

lookupObjectID, lookupUUID, queryACL, queryCommunitiesForPortlet, queryExtendedData, queryObjects, queryObjects, queryObjects, queryObjects, queryObjects, querySingleObject, updateACL

Method Detail

getCommunityPages

public IObjectQuery getCommunityPages(int communityID)
                               throws PortalException,
                                      java.rmi.RemoteException

Queries the community pages and their properties for a given community. The IObjectQueryRow objects in the IObjectQuery are returned in the same order as the pages in the community; using the server API terminology, the pages are sorted by PT_PROPIDS.PT_PROPID_PAGES_TOPICPOS.

Parameters:

communityID - if the community ID for the community to query

Returns:

if the pages within the community

Throws:

PortalException - if the operation resulted in an error on the portal

RemoteException - if there was a communication problem during the execution of the remote method call

getCommunityParentId

public int getCommunityParentId(int communityID)
                         throws PortalException,
                                java.rmi.RemoteException

Gets the parent ID of given community.

Parameters:

communityID - if the community ID for the community to to get parent id for

Returns:

the id of the parent community

Throws:

PortalException - if the operation resulted in an error on the portal

RemoteException - if there was a communication problem during the execution of the remote method call

isSubCommunitiesPresent

public boolean isSubCommunitiesPresent(int communityID)
                                throws PortalException,
                                       java.rmi.RemoteException

Queries and returns true if there are one or more sub communities for a given community, else the returned value is false.

Parameters:

communityID - if the community ID for the community to query

Returns:

true if there are sub communities, else false.

Throws:

PortalException

java.rmi.RemoteException

getSubCommunities

public IObjectQuery getSubCommunities(int communityID)
                               throws PortalException,
                                      java.rmi.RemoteException

Queries the sub communities for a given community. The IObjectQueryRow objects in the IObjectQuerye are returned in the same order as the sub communities in the community, each row represents a subcommunity and has the following values. OBJECTID, NAME, DESCRIPTION, ISLOCALIZED, FOLDERID and ACCESSLEVEL.

Parameters:

communityID - if the community ID for the community to query

Returns:

if the sub communities within the community

Throws:

PortalException

java.rmi.RemoteException