lumis.portal.channel.tree
Interface IChannelChildProvider

All Known Implementing Classes:

CategorizationServiceInstanceProvider, DocumentServiceInstanceProvider, ImageServiceInstanceProvider, PageProvider, ServiceInstanceProvider, ServiceInstanceProvider, TagServiceInstanceProvider

public interface IChannelChildProvider

Field Summary

static int	HIDE_TYPE_ALWAYS
static int	HIDE_TYPE_IF_HIDDEN_SPECIFIED
static int	HIDE_TYPE_NEVER

Method Summary

IChannelChild	getChannelChild(SessionConfig sessionConfig, java.lang.String childId, ITransaction transaction) Given a child Id, this method returns a IChannelChild object that represents the child.
java.util.List<IChannelChild>	getChannelsChildren(SessionConfig sessionConfig, java.lang.String parentChannelIds, boolean hidePages, boolean hidePageTemplates, IResource resource, java.util.Locale locale, ITransaction transaction) Given a set of parentChannelIds, this method is responsible for returning a List of the children.
java.util.List<IChannelChild>	getChildrenData(SessionConfig sessionConfig, java.lang.String channelId, int hideItems, int hideItemTemplates, IResource resource, java.util.Locale locale, ITransaction transaction) Given a parentChannelId, this method is responsible for returning a List of the children.

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

getChannelsChildren

java.util.List<IChannelChild> getChannelsChildren(SessionConfig sessionConfig,
                                                  java.lang.String parentChannelIds,
                                                  boolean hidePages,
                                                  boolean hidePageTemplates,
                                                  IResource resource,
                                                  java.util.Locale locale,
                                                  ITransaction transaction)
                                                  throws PortalException

Given a set of parentChannelIds, this method is responsible for returning a List of the children. This method is responsible for verifying access and must return only those children that the given session has access to.

Parameters:

sessionConfig -

parentChannelIds -

hidePages -

hidePageTemplates -

resource -

locale -

transaction -

Returns:

Throws:

PortalException

getChannelChild

IChannelChild getChannelChild(SessionConfig sessionConfig,
                              java.lang.String childId,
                              ITransaction transaction)
                              throws PortalException

Given a child Id, this method returns a IChannelChild object that represents the child.

Parameters:

sessionConfig -

childId -

transaction -

Returns:

Throws:

PortalException

getChildrenData

java.util.List<IChannelChild> getChildrenData(SessionConfig sessionConfig,
                                              java.lang.String channelId,
                                              int hideItems,
                                              int hideItemTemplates,
                                              IResource resource,
                                              java.util.Locale locale,
                                              ITransaction transaction)
                                              throws PortalException

Given a parentChannelId, this method is responsible for returning a List of the children. This method is responsible for verifying access and must return only those children that the given session has access to.

Parameters:

sessionConfig -

channelId -

hideItems -

hideItemTemplates -

resource -

locale -

transaction -

Returns:

Throws:

PortalException