com.sap.netweaver.bc.serialize

Interface IDeltaSerializer

public interface IDeltaSerializer

interface that can be implemented by ISerializer implementations. If this implementation is registered via ISerializerRegistrator, it will be called for each IResource that is serialized to check, if that resource has changed regarding the data that is handled by this very serializer. As this check might be expensive, it will be only called, if the IDeltaSerializer.DeltaSerializerParameters tell that we actually have a delta-serialization.

Nested Class Summary

static class

IDeltaSerializer.DeltaSerializerParameters container class to carry all needed information for the check if a resource has been modified As all its variables are immutable, so is this container.

Method Summary

boolean

isModified(IResource res, IRecursiveDeltaChecker checker) called prior to an actual serialization of an IResource.

Method Detail

isModified

boolean isModified(IResource res,
                   IRecursiveDeltaChecker checker)
                   throws WcmException

called prior to an actual serialization of an IResource. If one registered delta-serializer returns true, the complete serialization of an IResource is triggered. So even if this method returns false for a certain implementation, that implementation must serialize the resource just like it would do for a non-delta case. In other words: The method ISerializer.deserialize(com.sap.netweaver.bc.serialize.ISerializer.DeserializationParameters) must behave completely independent of this method.

Parameters:

res - the resource to check, must not be null

checker - the parameter package needed to check the given resource, must not be null

Returns:

flag stating if the resource has changed

Throws:

WcmException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM