lumis.portal.channel.tree
Interface IChannelTreeDao

All Known Implementing Classes:

ChannelTreeDaoJdbc

public interface IChannelTreeDao

Dao interface for channel tree.

Since:

4.0.0

Field Summary

static int	HIDE_TYPE_ALWAYS
static int	HIDE_TYPE_IF_HIDDEN_SPECIFIED
static int	HIDE_TYPE_NEVER

Method Summary

List<lumis.portal.channel.tree.Channel>	getBasicData(String channelId, boolean hideChannelTemplates, ITransaction transaction) Get the basic tree data of the channel.
List<lumis.portal.channel.tree.Channel>	getBasicDataWithRootChannel(String channelId, String rootChannelId, boolean hideChannelTemplates, ITransaction transaction) Get the basic tree data of the channel (with a given root channel).
List<lumis.portal.channel.tree.Channel>	getChildrenData(String channelId, int hideChannels, int hidePages, int hidePageTemplates, int hideChannelTemplates, ITransaction transaction) Get the tree childen's data of the channel.

Field Detail

HIDE_TYPE_NEVER

static final int HIDE_TYPE_NEVER

See Also:

Constant Field Values

HIDE_TYPE_ALWAYS

static final int HIDE_TYPE_ALWAYS

See Also:

Constant Field Values

HIDE_TYPE_IF_HIDDEN_SPECIFIED

static final int HIDE_TYPE_IF_HIDDEN_SPECIFIED

See Also:

Constant Field Values

Method Detail

getBasicData

List<lumis.portal.channel.tree.Channel> getBasicData(String channelId,
                                                     boolean hideChannelTemplates,
                                                     ITransaction transaction)
                                                     throws DaoException,
                                                            PortalException

Get the basic tree data of the channel. This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.

Parameters:

channelId -

hideChannelTemplates -

transaction -

Returns:

Throws:

DaoException

PortalException

getChildrenData

List<lumis.portal.channel.tree.Channel> getChildrenData(String channelId,
                                                        int hideChannels,
                                                        int hidePages,
                                                        int hidePageTemplates,
                                                        int hideChannelTemplates,
                                                        ITransaction transaction)
                                                        throws DaoException,
                                                               PortalException

Get the tree childen's data of the channel.

Parameters:

channelId -

hideChannels -

hidePages -

hidePageTemplates -

hideChannelTemplates -

transaction -

Returns:

Throws:

DaoException

PortalException

getBasicDataWithRootChannel

List<lumis.portal.channel.tree.Channel> getBasicDataWithRootChannel(String channelId,
                                                                    String rootChannelId,
                                                                    boolean hideChannelTemplates,
                                                                    ITransaction transaction)
                                                                    throws PortalException

Get the basic tree data of the channel (with a given root channel). This method returns all the parents (entire ancestry) of the given channel. This is the minimum information required to render a channel within its tree.

Parameters:

channelId - the channel id.

rootChannelId - the root channel id.

hideChannelTemplates - hides the channel templates.

transaction - the transaction to be used.

Returns:

the basic tree data of the channel (with a given root channel)

Throws:

PortalException

Since:

6.1.0