Package lumis.portal.channel

Interface IChannelDao

All Known Implementing Classes:

ChannelDaoJdbc

public interface IChannelDao

Dao Interface for Channel entity

Since:

4.0.0

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
void	add(ChannelConfig channelConfig, ITransaction transaction)	Add the channel.
void	addCss(java.lang.String channelId, java.lang.String cssId, int position, ITransaction transaction)	Add the CSS of the channel.
boolean	checkForChannelPrefix(ChannelConfig channelConfig, ITransaction transaction)	Returns if the channel prefix for local groups is already in use.
void	delete(java.lang.String channelId, ITransaction transaction)	Delete the channel.
void	deleteCss(java.lang.String channelId, java.lang.String cssId, ITransaction transaction)	Delete the CSS of the channel.
java.lang.String	generateRandomChannelPrefix(ITransaction transaction)	Generates a new random channel prefix, that is not already in use.
ChannelConfig	get(java.lang.String channelId, ITransaction transaction)	Returns the channel with the specified channelId.
int	getChannelTreeCount(java.lang.String rootChannelId, ITransaction transaction)
java.util.List<java.lang.String>	getChannelTreeIds(java.lang.String rootChannelId, boolean includeIgnoredOnImportExportChannels, ITransaction transaction)	Returns the tree identifiers of the root channel identified by the given identifier.
java.util.List<java.lang.String>	getChannelTreeIds(java.lang.String rootChannelId, ITransaction transaction)
java.util.List<java.lang.String>	getCssIds(java.lang.String channelId, ITransaction transaction)	Get the ids of the channel's CSS.
java.lang.String	getIdByChannelPrefix(ChannelConfig channelConfig, ITransaction transaction)
java.util.Collection<java.lang.String>	getIdsByPageTemplateId(java.lang.String pageTemplateId, ITransaction transaction)	Get the Ids of all channels that have the specified page template as the default page template
java.util.List<java.lang.String>	getIdsByParentTemplateId(java.lang.String parentTemplateId, ITransaction transaction)	Get the Ids of all channels associated with the specified template id.
java.util.List<java.lang.String>	getSubChannelIds(java.lang.String channelId, ITransaction transaction)	Get a list with ids of the sub channels.
void	update(ChannelConfig channelConfig, ITransaction transaction)	Update the channel.

Method Detail

add

void add(ChannelConfig channelConfig,
         ITransaction transaction)
  throws DaoException,
         PortalException

Add the channel.

Parameters:

channelConfig -

transaction -

Throws:

DaoException

PortalException

get

ChannelConfig get(java.lang.String channelId,
                  ITransaction transaction)
           throws DaoException,
                  PortalException

Returns the channel with the specified channelId.

Parameters:

channelId - the channelId.

transaction - the transaction for persistence access.

Returns:

the channel.

Throws:

PortalObjectNotFoundException - if the channel was not found.

DaoException

PortalException

update

void update(ChannelConfig channelConfig,
            ITransaction transaction)
     throws DaoException,
            PortalException

Update the channel.

Parameters:

channelConfig -

transaction -

Throws:

DaoException

PortalException

delete

void delete(java.lang.String channelId,
            ITransaction transaction)
     throws DaoException,
            PortalException

Delete the channel.

Parameters:

channelId -

transaction -

Throws:

DaoException

PortalException

getSubChannelIds

java.util.List<java.lang.String> getSubChannelIds(java.lang.String channelId,
                                                  ITransaction transaction)
                                           throws DaoException,
                                                  PortalException

Get a list with ids of the sub channels.

Parameters:

channelId -

transaction -

Returns:

an array of Strings.

Throws:

DaoException

PortalException

addCss

void addCss(java.lang.String channelId,
            java.lang.String cssId,
            int position,
            ITransaction transaction)
     throws DaoException,
            PortalException

Add the CSS of the channel.

Parameters:

channelId -

cssId -

position -

transaction -

Throws:

DaoException

PortalException

deleteCss

void deleteCss(java.lang.String channelId,
               java.lang.String cssId,
               ITransaction transaction)
        throws DaoException,
               PortalException

Delete the CSS of the channel.

Parameters:

channelId -

cssId -

transaction -

Throws:

DaoException

PortalException

getCssIds

java.util.List<java.lang.String> getCssIds(java.lang.String channelId,
                                           ITransaction transaction)
                                    throws DaoException,
                                           PortalException

Get the ids of the channel's CSS.

Parameters:

channelId -

transaction -

Returns:

an array of Strings.

Throws:

DaoException

PortalException

checkForChannelPrefix

boolean checkForChannelPrefix(ChannelConfig channelConfig,
                              ITransaction transaction)
                       throws DaoException,
                              PortalException

Returns if the channel prefix for local groups is already in use. If channel does not have local groups prefix specified, returns false.

Parameters:

channelConfig -

transaction -

Returns:

Throws:

PortalException

UnexpectedException

DaoException

getIdsByParentTemplateId

java.util.List<java.lang.String> getIdsByParentTemplateId(java.lang.String parentTemplateId,
                                                          ITransaction transaction)
                                                   throws DaoException,
                                                          PortalException

Get the Ids of all channels associated with the specified template id.

Parameters:

parentTemplateId -

transaction -

Returns:

Throws:

DaoException

PortalException

Since:

4.0.4

getIdsByPageTemplateId

java.util.Collection<java.lang.String> getIdsByPageTemplateId(java.lang.String pageTemplateId,
                                                              ITransaction transaction)
                                                       throws DaoException,
                                                              PortalException

Get the Ids of all channels that have the specified page template as the default page template

Parameters:

pageTemplateId -

transaction -

Returns:

Throws:

DaoException

PortalException

Since:

4.0.8

getChannelTreeCount

int getChannelTreeCount(java.lang.String rootChannelId,
                        ITransaction transaction)
                 throws DaoException,
                        PortalException

Throws:

DaoException

PortalException

getChannelTreeIds

java.util.List<java.lang.String> getChannelTreeIds(java.lang.String rootChannelId,
                                                   ITransaction transaction)
                                            throws DaoException,
                                                   PortalException

Throws:

DaoException

PortalException

getChannelTreeIds

java.util.List<java.lang.String> getChannelTreeIds(java.lang.String rootChannelId,
                                                   boolean includeIgnoredOnImportExportChannels,
                                                   ITransaction transaction)
                                            throws DaoException,
                                                   PortalException

Returns the tree identifiers of the root channel identified by the given identifier.

Parameters:

rootChannelId - the root channel identifier.

includeIgnoredOnImportExportChannels - indicates whether the ignored channels on export and import should be ignored.

transaction - the transaction.

Returns:

the tree identifiers of the root channel identified by the given identifier.

Throws:

DaoException

PortalException

Since:

8.0.0

getIdByChannelPrefix

java.lang.String getIdByChannelPrefix(ChannelConfig channelConfig,
                                      ITransaction transaction)
                               throws DaoException,
                                      PortalException

Throws:

DaoException

PortalException

generateRandomChannelPrefix

java.lang.String generateRandomChannelPrefix(ITransaction transaction)
                                      throws PortalException

Generates a new random channel prefix, that is not already in use.

Parameters:

transaction - the transaction for persistence access.

Returns:

the generated channel prefix.

Throws:

PortalException

Since:

6.0.0