Package lumis.portal.serialization

Class SerializationContext

java.lang.Object

lumis.portal.serialization.BaseSerializationContext

lumis.portal.serialization.SerializationContext

public class SerializationContext
extends BaseSerializationContext

Context class for portal objects serialization

Since:

4.0.7

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor	Description
SerializationContext(SessionConfig sessionConfig, ITransaction transaction, java.lang.String rootChannelId, IDirectory directory, boolean progressEnabled, boolean includeContent)
SerializationContext(SessionConfig sessionConfig, ITransaction transaction, java.lang.String rootChannelId, IDirectory directory, boolean progressEnabled, boolean includeContent, boolean forExport)

Method Summary

Modifier and Type	Method	Description
void	addReferencedServiceInterface(java.lang.String serviceId, java.lang.String serviceInterfaceId)
java.util.Set<java.lang.String>	getChannelIds()
java.util.List<Dependency>	getExternalDependencies()
java.util.Map<java.lang.String,Dependency>	getExternalServiceInstanceDependencies()
boolean	getIncludeUserMembership()	Indicates if information about users being member of a group being exported is to be included.
java.util.Set<java.lang.String>	getReferencedCssIds()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getReferencedServiceInterfaceIds()
java.util.Set<java.lang.String>	getReferencedServiceInterfaceStyleIds()
ServiceInstanceSerializationContext	getServiceInstanceSerializationContext()
boolean	getShowExternalDependencyWarnings()
boolean	isForExport()
void	setIncludeUserMembership(boolean include)	Sets if information about users being member of a group being exported is to be included.
void	setShallowSerialization(boolean shallowSerialization)	Sets whether the serialization will serialize the structure recursively or not.
void	setShowExternalDependencyWarnings(boolean showExternalDependencyWarnings)
void	setTransaction(ITransaction transaction)

Methods inherited from class lumis.portal.serialization.BaseSerializationContext

getCurrentChannelPath, getDefaultSerializer, getDirectory, getGlobalGroups, getIncludeContent, getItemProgressMax, getItemProgressValue, getOverallProgressMax, getOverallProgressValue, getProcessId, getProgressEnabled, getResource, getRootChannelId, getSerializationSettings, getSessionConfig, getStartTime, getTransaction, incrementItemProgressValue, incrementOverallProgressValue, isShallowSerialization, logDebug, logDebug, logDebug, sendProgressFinalNotification, sendProgressNotification, sendProgressNotification, setCurrentChannelPath, setDefaultSerializer, setDirectory, setItemProgressMax, setItemProgressValue, setOverallProgressMax, setOverallProgressValue, setProcessId, setRootChannelId, setSerializationSettings, setStartTime, updateProgressBar, updateProgressBar

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializationContext

public SerializationContext(SessionConfig sessionConfig,
                            ITransaction transaction,
                            java.lang.String rootChannelId,
                            IDirectory directory,
                            boolean progressEnabled,
                            boolean includeContent)
                     throws PortalException

Throws:

PortalException

SerializationContext

public SerializationContext(SessionConfig sessionConfig,
                            ITransaction transaction,
                            java.lang.String rootChannelId,
                            IDirectory directory,
                            boolean progressEnabled,
                            boolean includeContent,
                            boolean forExport)
                     throws PortalException

Throws:

PortalException

Method Detail

getReferencedServiceInterfaceStyleIds

public java.util.Set<java.lang.String> getReferencedServiceInterfaceStyleIds()

getReferencedCssIds

public java.util.Set<java.lang.String> getReferencedCssIds()

getReferencedServiceInterfaceIds

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getReferencedServiceInterfaceIds()

addReferencedServiceInterface

public void addReferencedServiceInterface(java.lang.String serviceId,
                                          java.lang.String serviceInterfaceId)

getExternalDependencies

public java.util.List<Dependency> getExternalDependencies()

getExternalServiceInstanceDependencies

public java.util.Map<java.lang.String,Dependency> getExternalServiceInstanceDependencies()

getChannelIds

public java.util.Set<java.lang.String> getChannelIds()

getServiceInstanceSerializationContext

public ServiceInstanceSerializationContext getServiceInstanceSerializationContext()

getShowExternalDependencyWarnings

public boolean getShowExternalDependencyWarnings()

setShowExternalDependencyWarnings

public void setShowExternalDependencyWarnings(boolean showExternalDependencyWarnings)

setTransaction

public void setTransaction(ITransaction transaction)

Overrides:

setTransaction in class BaseSerializationContext

setShallowSerialization

public void setShallowSerialization(boolean shallowSerialization)

Sets whether the serialization will serialize the structure recursively or not. See BaseSerializationContext.isShallowSerialization() for more details on recursion implications.

Overrides:

setShallowSerialization in class BaseSerializationContext

Parameters:

shallowSerialization - the shallow serialization value.

Since:

5.0.0

getIncludeUserMembership

public boolean getIncludeUserMembership()

Indicates if information about users being member of a group being exported is to be included.

Note that this refers only to members that are users, this does not affect members that are groups.

Returns:

if true, information about users being member of a group being exported is to be included; if false such information must not be included.

Since:

4.2.1

setIncludeUserMembership

public void setIncludeUserMembership(boolean include)

Sets if information about users being member of a group being exported is to be included.

Note that this refers only to members that are users, this does not affect members that are groups.

Parameters:

include - true to be included, false otherwise.

Since:

4.2.1

isForExport

public boolean isForExport()