Package lumis.portal.channel.tree

Interface IChannelTreeDao

All Known Implementing Classes:

ChannelTreeDaoJdbc

public interface IChannelTreeDao

Dao interface for channel tree.

Since:

4.0.0

Version:

$Revision: 19931 $ $Date: 2017-02-16 13:06:03 -0200 (Thu, 16 Feb 2017) $

Field Summary

Fields

Modifier and Type	Field	Description
static int	HIDE_TYPE_ALWAYS
static int	HIDE_TYPE_IF_HIDDEN_SPECIFIED
static int	HIDE_TYPE_NEVER

Method Summary

Modifier and Type	Method	Description
Map<String,List<lumis.portal.channel.tree.Channel>>	getBasicData(String channelId, boolean hideChannelTemplates, String primaryServiceInstanceId, ITransaction transaction)	Get the basic tree data of the channel considering area tags from each channel.
Map<String,List<lumis.portal.channel.tree.Channel>>	getBasicData(String channelId, boolean hideChannelTemplates, ITransaction transaction)	Get the basic tree data of the channel.
Map<String,List<lumis.portal.channel.tree.Channel>>	getBasicDataWithAreaTags(String channelId, String rootChannelId, boolean hideChannelTemplates, Collection<String> areaTags, ITransaction transaction)	Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels.
Map<String,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).
org.json.simple.JSONArray	getChannelChildren(String channelId, ITransaction transaction)
org.json.simple.JSONObject	getChannelTree(String channelId, boolean includeParents, boolean localizeNames, ITransaction transaction)
Map<String,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

getChannelTree

org.json.simple.JSONObject getChannelTree(String channelId,
                                          boolean includeParents,
                                          boolean localizeNames,
                                          ITransaction transaction)
                                   throws DaoException,
                                          PortalException

Throws:

DaoException

PortalException

getChannelChildren

org.json.simple.JSONArray getChannelChildren(String channelId,
                                             ITransaction transaction)
                                      throws DaoException,
                                             PortalException

Throws:

DaoException

PortalException

getBasicData

Map<String,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

Map<String,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

Map<String,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

getBasicData

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

Get the basic tree data of the channel considering area tags from each 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 current channel id.

hideChannelTemplates - if is to hide or not channel templates.

serviceInstancePrimary - the service instance that have the channel the area tags that will define witch channel will be returned.

transaction - the transaction to be used during the process.

Returns:

the basic tree data of the channel considering area tags from each channel.

Throws:

DaoException - if any error occurs during the data base query.

PortalException - if any other error occurs during the process.

Since:

7.1.0

getBasicDataWithAreaTags

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

Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels. 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 current channel id.

rootChannelId - the root channel that will be used as reference to start the query.

hideChannelTemplates - if is to hide or not channel templates.

areaTags - the list of area tags that the channels must have (at least one) to be returned.

transaction - the transaction to be used during the process.

Returns:

Get the basic tree data of the channel (with a given root channel) considering area tags from each child channels.

Throws:

PortalException - if any other error occurs during the process.

Since:

7.1.0