lumis.portal.channel.serialization
Interface IChannelSerializationManager

All Superinterfaces:

IConfigDeleter, IConfigPersister

All Known Implementing Classes:

ChannelSerializationManager

public interface IChannelSerializationManager
extends IConfigPersister, IConfigDeleter

Manager Interface for Channel serialization

Since:

4.0.7

Method Summary

String	deserialize(DeserializationContext deserializationContext, ChannelSerializableConfig channelSerializableConfig, ChannelSerializableConfig parentChannelSerializableConfig) Deserialize a channel.
ChannelConfig	deserializeConfig(DeserializationContext deserializationContext, String channelId) Deserialize a ChannelConfig object.
void	deserializeContent(DeserializationContext deserializationContext, ChannelSerializableConfig channelSerializableConfig, ChannelSerializableConfig parentChannelSerializableConfig) Deserialize channel content.
int	getProgressDeserializationItemCount() Get the number of steps of a channel deserialization process.
int	getProgressSerializationItemCount() Get the number of steps of a channel serialization process.
SerializationMessageConfigNode	getSerializationMessageConfigNode(BaseSerializationContext serializationContext, ChannelConfig channelConfig) Get a SerializationMessageConfigNode object containing fully recursive information about a channel.
ChannelSerializableConfig	serialize(SerializationContext serializationContext, String channelId) Serialize a channel.
void	setupSerializationContext(BaseSerializationContext serializationContext) Set up a serialization context, defining settings such as class aliases, field aliases, transient fields, omitted collections etc.

Methods inherited from interface lumis.portal.serialization.operation.IConfigPersister

persistConfig

Methods inherited from interface lumis.portal.serialization.operation.IConfigDeleter

deleteConfig

Method Detail

deserialize

String deserialize(DeserializationContext deserializationContext,
                   ChannelSerializableConfig channelSerializableConfig,
                   ChannelSerializableConfig parentChannelSerializableConfig)
                   throws PortalException

Deserialize a channel.

Parameters:

deserializationContext -

channelSerializableConfig -

parentChannelSerializableConfig -

Returns:

deserialized channelId

Throws:

PortalException

deserializeContent

void deserializeContent(DeserializationContext deserializationContext,
                        ChannelSerializableConfig channelSerializableConfig,
                        ChannelSerializableConfig parentChannelSerializableConfig)
                        throws PortalException

Deserialize channel content. For all service instances below the channel the content must be deserialized.

Parameters:

deserializationContext - context for deserialization

channelSerializableConfig - channel for which content must be deserialized

parentChannelSerializableConfig - parent channel of the channel to be deserialized

Throws:

PortalException

Since:

4.2.0

deserializeConfig

ChannelConfig deserializeConfig(DeserializationContext deserializationContext,
                                String channelId)
                                throws ManagerException

Deserialize a ChannelConfig object.

Parameters:

deserializationContext -

channelId -

Returns:

Throws:

ManagerException

serialize

ChannelSerializableConfig serialize(SerializationContext serializationContext,
                                    String channelId)
                                    throws PortalException

Serialize a channel.

Parameters:

serializationContext -

channelId -

Returns:

Throws:

PortalException

setupSerializationContext

void setupSerializationContext(BaseSerializationContext serializationContext)

Set up a serialization context, defining settings such as class aliases, field aliases, transient fields, omitted collections etc.

Parameters:

serializationContext -

getSerializationMessageConfigNode

SerializationMessageConfigNode getSerializationMessageConfigNode(BaseSerializationContext serializationContext,
                                                                 ChannelConfig channelConfig)
                                                                 throws PortalException

Get a SerializationMessageConfigNode object containing fully recursive information about a channel.

Parameters:

serializationContext -

channelConfig -

Returns:

Throws:

PortalException

getProgressSerializationItemCount

int getProgressSerializationItemCount()

Get the number of steps of a channel serialization process.

Returns:

getProgressDeserializationItemCount

int getProgressDeserializationItemCount()

Get the number of steps of a channel deserialization process.

Returns: