lumis.portal.channel.template
Interface IChannelTemplateManager

All Known Implementing Classes:

ChannelTemplateManager

@StableMinor(version="4.1",
             sinceVersion="4.0")
public interface IChannelTemplateManager

Definition of the channel template information management interface.

Since:

4.0.0

Method Summary

String	addChannelLink(SessionConfig sessionConfig, ChannelTemplateLinkConfig channelTemplateLinkConfig, ITransaction transaction) Add a channel's link.
void	deleteChannelLink(SessionConfig sessionConfig, String channelLinkId, ITransaction transaction) Delete a specific channel's link by pass channelLinkId.
void	deleteChannelLinks(SessionConfig sessionConfig, String channelId, ITransaction transaction) Delete all channel's links by pass channelId.
String	deserializeChannelTemplateLink(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node linkNode, ITransaction transaction) Deserializes the channel template link in the given node.
void	disconnectFromTemplate(SessionConfig sessionConfig, String channelId, ITransaction transaction) This method disconnects the specific channel from the channel's template.
ChannelTemplateLinkConfig	getChannelLinkBySourceId(SessionConfig sessionConfig, String channelId, String sourceId, boolean getLinkedElementsOnly, ITransaction transaction) This method return the channel's link by pass the channelId and the sourceId parameters.
List<ChannelTemplateLinkConfig>	getChannelLinks(SessionConfig sessionConfig, String channelId, boolean getLinkedElementsOnly, ITransaction transaction) This method return channel's links by pass the channelId parameter.
void	serializeChannelTemplateLinks(SessionConfig sessionConfig, String channelId, OutputStream outputStream, ITransaction transaction) Serializes the channel template links of a single channel.
void	updateChannelStructureFromTemplate(SessionConfig sessionConfig, String channelId, ITransaction transaction) This method updates the channel's structure from the channel template.

Method Detail

updateChannelStructureFromTemplate

void updateChannelStructureFromTemplate(SessionConfig sessionConfig,
                                        String channelId,
                                        ITransaction transaction)
                                        throws ManagerException,
                                               PortalException

This method updates the channel's structure from the channel template.

Parameters:

sessionConfig -

channelId -

transaction -

Throws:

ManagerException

PortalException

disconnectFromTemplate

void disconnectFromTemplate(SessionConfig sessionConfig,
                            String channelId,
                            ITransaction transaction)
                            throws ManagerException,
                                   PortalException

This method disconnects the specific channel from the channel's template.

Parameters:

sessionConfig -

channelId -

transaction -

Throws:

ManagerException

PortalException

getChannelLinks

List<ChannelTemplateLinkConfig> getChannelLinks(SessionConfig sessionConfig,
                                                String channelId,
                                                boolean getLinkedElementsOnly,
                                                ITransaction transaction)
                                                throws ManagerException,
                                                       PortalException

This method return channel's links by pass the channelId parameter. If the parameter getLinkedElementsOnly is true the method returns only the links is enable. If the parameter is false it returns all links.

Parameters:

sessionConfig -

channelId -

getLinkedElementsOnly -

transaction -

Returns:

Returns the channel's links.

Throws:

ManagerException

PortalException

getChannelLinkBySourceId

ChannelTemplateLinkConfig getChannelLinkBySourceId(SessionConfig sessionConfig,
                                                   String channelId,
                                                   String sourceId,
                                                   boolean getLinkedElementsOnly,
                                                   ITransaction transaction)
                                                   throws ManagerException,
                                                          PortalException

This method return the channel's link by pass the channelId and the sourceId parameters. If the parameter getLinkedElementsOnly is true the method returns only the links is enable. If the parameter is false it returns all links.

Parameters:

sessionConfig -

channelId -

sourceId -

getLinkedElementsOnly -

transaction -

Returns:

Returns the channel link.

Throws:

ManagerException

PortalException

addChannelLink

String addChannelLink(SessionConfig sessionConfig,
                      ChannelTemplateLinkConfig channelTemplateLinkConfig,
                      ITransaction transaction)
                      throws ManagerException,
                             PortalException

Add a channel's link.

Parameters:

sessionConfig -

channelTemplateLinkConfig -

transaction -

Returns:

Returns the Id of the channelTemplateLinkConfig.

Throws:

ManagerException

PortalException

deleteChannelLink

void deleteChannelLink(SessionConfig sessionConfig,
                       String channelLinkId,
                       ITransaction transaction)
                       throws ManagerException,
                              PortalException

Delete a specific channel's link by pass channelLinkId.

Parameters:

sessionConfig -

channelLinkId -

transaction -

Throws:

ManagerException

PortalException

deleteChannelLinks

void deleteChannelLinks(SessionConfig sessionConfig,
                        String channelId,
                        ITransaction transaction)
                        throws ManagerException,
                               PortalException

Delete all channel's links by pass channelId.

Parameters:

sessionConfig -

channelId -

transaction -

Throws:

ManagerException

PortalException

serializeChannelTemplateLinks

void serializeChannelTemplateLinks(SessionConfig sessionConfig,
                                   String channelId,
                                   OutputStream outputStream,
                                   ITransaction transaction)
                                   throws ManagerException,
                                          PortalException

Serializes the channel template links of a single channel.

Parameters:

sessionConfig - the user session information.

channelId - the channel id.

outputStream - the outputstream to serialize the data to.

transaction - the transaction for persistence access.

Throws:

ManagerException

PortalException

Since:

4.0.6

deserializeChannelTemplateLink

String deserializeChannelTemplateLink(SessionConfig sessionConfig,
                                      DeserializationConfig deserializationConfig,
                                      Node linkNode,
                                      ITransaction transaction)
                                      throws ManagerException,
                                             PortalException

Deserializes the channel template link in the given node.

Parameters:

sessionConfig - the user session information.

deserializationConfig - deserialization configuration.

linkNode - the node containing the channel template link information.

transaction - the transaction for persistence access.

Returns:

the deserialized channel template link id.

Throws:

ManagerException

PortalException

Since:

4.0.6