lumis.doui.control.selectserviceinstance
Class ServiceInstanceProvider

java.lang.Object
  lumis.doui.control.selectserviceinstance.ServiceInstanceProvider

All Implemented Interfaces:

IChannelChildProvider

Direct Known Subclasses:

CategorizationServiceInstanceProvider, DocumentServiceInstanceProvider, ImageServiceInstanceProvider

public class ServiceInstanceProvider
extends Object
implements IChannelChildProvider

Provides service instances that are children of a specified channel.

Since:

4.0.1

Field Summary

Fields inherited from interface lumis.portal.channel.tree.IChannelChildProvider

HIDE_TYPE_ALWAYS, HIDE_TYPE_IF_HIDDEN_SPECIFIED, HIDE_TYPE_NEVER

Constructor Summary

ServiceInstanceProvider()

ServiceInstanceProvider(String serviceId)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceInstanceProvider

public ServiceInstanceProvider()

ServiceInstanceProvider

public ServiceInstanceProvider(String serviceId)

Method Detail

getChannelChild

public IChannelChild getChannelChild(SessionConfig sessionConfig,
                                     String childId,
                                     ITransaction transaction)
                              throws PortalException

Description copied from interface: IChannelChildProvider

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

Specified by:

getChannelChild in interface IChannelChildProvider

Returns:

Throws:

PortalException

getChannelsChildren

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

Description copied from interface: IChannelChildProvider

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.

Specified by:

getChannelsChildren in interface IChannelChildProvider

Returns:

Throws:

PortalException

getChildrenData

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

Description copied from interface: IChannelChildProvider

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.

Specified by:

getChildrenData in interface IChannelChildProvider

Returns:

Throws:

PortalException