lumis.portal.channel
Interface IChannelDao

Package class diagram package IChannelDao
All Known Implementing Classes:
ChannelDaoJdbc

public interface IChannelDao

Dao Interface for Channel entity

Since:
4.0.0

Method Summary
 void add(ChannelConfig channelConfig, ITransaction transaction)
          Add the channel.
 void addCss(String channelId, 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(String channelId, ITransaction transaction)
          Delete the channel.
 void deleteCss(String channelId, String cssId, ITransaction transaction)
          Delete the CSS of the channel.
 ChannelConfig get(String channelId, ITransaction transaction)
          Returns the channel with the specified channelId.
 int getChannelTreeCount(String rootChannelId, ITransaction transaction)
           
 List<String> getChannelTreeIds(String rootChannelId, ITransaction transaction)
           
 List<String> getCssIds(String channelId, ITransaction transaction)
          Get the ids of the channel's CSS.
 String getIdByChannelPrefix(ChannelConfig channelConfig, ITransaction transaction)
           
 Collection<String> getIdsByPageTemplateId(String pageTemplateId, ITransaction transaction)
          Get the Ids of all channels that have the specified page template as the default page template
 List<String> getIdsByParentTemplateId(String parentTemplateId, ITransaction transaction)
          Get the Ids of all channels associated with the specified template id.
 List<String> getSubChannelIds(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(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(String channelId,
            ITransaction transaction)
            throws DaoException,
                   PortalException
Delete the channel.

Parameters:
channelId -
transaction -
Throws:
DaoException
PortalException

getSubChannelIds

List<String> getSubChannelIds(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(String channelId,
            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(String channelId,
               String cssId,
               ITransaction transaction)
               throws DaoException,
                      PortalException
Delete the CSS of the channel.

Parameters:
channelId -
cssId -
transaction -
Throws:
DaoException
PortalException

getCssIds

List<String> getCssIds(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

List<String> getIdsByParentTemplateId(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

Collection<String> getIdsByPageTemplateId(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(String rootChannelId,
                        ITransaction transaction)
                        throws DaoException,
                               PortalException
Throws:
DaoException
PortalException

getChannelTreeIds

List<String> getChannelTreeIds(String rootChannelId,
                               ITransaction transaction)
                               throws DaoException,
                                      PortalException
Throws:
DaoException
PortalException

getIdByChannelPrefix

String getIdByChannelPrefix(ChannelConfig channelConfig,
                            ITransaction transaction)
                            throws DaoException,
                                   PortalException
Throws:
DaoException
PortalException


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.