com.sap.netweaver.bc.serialize

Interface IDependantRidQueue

public interface IDependantRidQueue

Allows to add dependant ITransportObject s to a ITransport that is beeing finalized.

Copyright 2004 SAP AG

Method Summary

boolean	add(RID rid, boolean exclusive, ISerializer serializer) Adds the resource rid as dependant resource to an ITransport.
boolean	contains(RID rid) this is a precheck for the add(RID, boolean, ISerializer) method.
void	flush() Flushes the queue resulting in the export of all dependant resources currently contained in the queue.

Method Detail

add

boolean add(RID rid,
            boolean exclusive,
            ISerializer serializer)

Adds the resource rid as dependant resource to an ITransport.

Parameters:

rid - the rid to add to the transport (must not be null)

exclusive - true causes that this resource will only be imported if the serializer, that requested the export, also requests explicitly the import. false will result in importing the resource like all other resources

serializer - the serializer which initiated the call (must not be null)

Returns:

flag true if the RID was added successfully, false if the RID was already added (regardless of the exclusive mode).

flush

void flush()

Flushes the queue resulting in the export of all dependant resources currently contained in the queue.

This method must only be called after a resource has been completely processed, i.e. not between the calls to serializer1 and serializer2 for serialization of the same resource.

contains

boolean contains(RID rid)

this is a precheck for the add(RID, boolean, ISerializer) method. It simply checks if the given RID is already in the queue. It will not modify the content of the rid queue. This method is only for performance improvements - a caller might be able to reduce its calculations to decide if a RID needs to be transported or not: If it is already transported, it can just stop.
In implementation can also return true, if the given RID will not be added to its queue for other reasons (e.g. because this RID is transported as a primary object already)

Parameters:

rid - the rid to check, must not be null

Returns:

flag stating if this rid is already in the queue or not. As serialization is not multithreaded, there is no race-condition.

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