lumis.portal.channel.tree
Class ChannelTreeManager

java.lang.Object
  lumis.portal.channel.tree.ChannelTreeManager

All Implemented Interfaces:

IChannelTreeManager

public class ChannelTreeManager
extends Object
implements IChannelTreeManager

Constructor Summary

ChannelTreeManager()

Method Summary

protected void	addChannels(StringBuilder result, StringBuilder parentChannelIds, List<lumis.portal.channel.tree.Channel> channelChildren, ILocalizationManager localizationManager, IResource resource, SessionConfig sessionConfig, ITransaction transaction)
protected void	addPages(StringBuilder result, List<IChannelChild> children, SessionConfig sessionConfig, ITransaction transaction)
String	getBasicData(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, String channelId, boolean hidePages, boolean hidePageTemplates, boolean hideChannelTemplates, ITransaction transaction) Get the basic tree data of the channel.
String	getBasicData(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, String channelId, String rootChannelId, boolean hidePages, boolean hidePageTemplates, boolean hideChannelTemplates, ITransaction transaction) Get the basic tree data of the channel.
String	getChildrenData(SessionConfig sessionConfig, IChannelChildProvider channelChildProvider, String channelId, int hideChannels, int hidePages, int hidePageTemplates, int hideChannelTemplates, ITransaction transaction) Get the children's tree data of the channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelTreeManager

public ChannelTreeManager()

Method Detail

getBasicData

public String getBasicData(SessionConfig sessionConfig,
                           IChannelChildProvider channelChildProvider,
                           String channelId,
                           boolean hidePages,
                           boolean hidePageTemplates,
                           boolean hideChannelTemplates,
                           ITransaction transaction)
                    throws ManagerException,
                           PortalException

Description copied from interface: IChannelTreeManager

Get the basic tree data of the channel. Given a channelId, this method returns this channels immediate children and the immediate children of all the channels in its parent path. To access this method, the user needs the PERMISSION_TYPE_VIEW_CHANNEL permission.

Specified by:

getBasicData in interface IChannelTreeManager

Returns:

Returns the list of channel's Id.

Throws:

ManagerException

PortalException

getBasicData

public String getBasicData(SessionConfig sessionConfig,
                           IChannelChildProvider channelChildProvider,
                           String channelId,
                           String rootChannelId,
                           boolean hidePages,
                           boolean hidePageTemplates,
                           boolean hideChannelTemplates,
                           ITransaction transaction)
                    throws ManagerException,
                           PortalException

Description copied from interface: IChannelTreeManager

Get the basic tree data of the channel. Given a channelId and a root channel id, this method returns this channels immediate children and the immediate children of all the channels in its parent path. To access this method, the user needs the PERMISSION_TYPE_VIEW_CHANNEL permission.

Specified by:

getBasicData in interface IChannelTreeManager

Parameters:

sessionConfig - the user's session.

channelChildProvider - the channel child provider.

channelId - the channel id.

rootChannelId - the root channel id.

hidePages - hides pages.

hidePageTemplates - hides page templates.

hideChannelTemplates - hides channel templates.

transaction - the transaction.

Returns:

the basic tree data of the channel

Throws:

ManagerException

PortalException

addChannels

protected void addChannels(StringBuilder result,
                           StringBuilder parentChannelIds,
                           List<lumis.portal.channel.tree.Channel> channelChildren,
                           ILocalizationManager localizationManager,
                           IResource resource,
                           SessionConfig sessionConfig,
                           ITransaction transaction)
                    throws PortalException

Throws:

PortalException

addPages

protected void addPages(StringBuilder result,
                        List<IChannelChild> children,
                        SessionConfig sessionConfig,
                        ITransaction transaction)
                 throws PortalException

Throws:

PortalException

getChildrenData

public String getChildrenData(SessionConfig sessionConfig,
                              IChannelChildProvider channelChildProvider,
                              String channelId,
                              int hideChannels,
                              int hidePages,
                              int hidePageTemplates,
                              int hideChannelTemplates,
                              ITransaction transaction)
                       throws ManagerException,
                              PortalException

Description copied from interface: IChannelTreeManager

Get the children's tree data of the channel. Given a channelId, this method returns the immediate children of the channel. To access this method, the user needs the PERMISSION_TYPE_VIEW_CHANNEL permission.

Specified by:

getChildrenData in interface IChannelTreeManager

Returns:

Returns the channel's Id.

Throws:

ManagerException

PortalException