com.sapportals.wcm.repository.manager

Interface ISerializedResourceEvent

All Superinterfaces:

IEvent

All Known Subinterfaces:

ISerializedVariantResourceEvent

All Known Implementing Classes:

SerializedResourceEventTemplate

public interface ISerializedResourceEvent
extends IEvent

Specifies a serialized resource event, that is an event which is persisted in the database. When the RF is reading the serialized form of an event it is not possible to create a full-fledged resource event for several reasons, e.g the RF has no access to the constructor (defined by an event sender that uses a subclass of ResourceEvent) and the resource associated with the event might no longer exist (e.g. rename, delete). Therefore event receivers which register themselves for persistent events must adapt their event registration and handling code. In particular receivers have to adapt the code that detects different subclasses of ResourceEvent because instanceof will not work for these events. The following code example shows how it should be done:

 public void received(IEvent event) {  
   if (event instanceof ISerializedResourceEvent) {
     if (((ISerializedResourceEvent)event).getSubClassName().equals(IExtendedEvent.class.getName())) {
       ...
     }
   }
   else ...
 }
 
 

The event's parameter (IEvent.getParameter()) is not persisted for extended events. The parameter of serialized resource events does not support all objects used be the ResourceEvent. Depending on the event type the following parameters are not supported (null is returned) or converted to other objects:
CREATE_XXX: RID instead of IResource
COPY, MOVE: RID instead of IResource
LOCK, UNLOCK: ILockInfo is not supported
PROPERTY_DELETE: IPropertyDef is not supported
PROPERTY_SET: IPropertyName instead of IProperty
DELETE: IRidList is not supported

Method Summary

Modifier and Type	Method and Description
long	getAutoID()
boolean	getCollectionFlag() Returns true if the resource is/was a collection - this flag is especially useful with DELETE events.
RID	getRID() Returns the resource identifier of the resource associated with this event.
long	getSendTime()
String	getSubClassName() Returns the name of the interface of the "extended" resource event: The returned name is the name of the interface that extends IResourceEvent.

Methods inherited from interface com.sapportals.wcm.util.events.IEvent

getDescription, getDescription, getParameter, getType, isLike

Method Detail

getRID

RID getRID()

Returns the resource identifier of the resource associated with this event. Note: Obviously it is not possible to get a resource instance for this RID in case of a delete event, because the resource was already deleted - if a resource exists for the RID a new one must have been created in the meantime with the same name.

Returns:

the resource identifier of the resource associated with this event.

getCollectionFlag

boolean getCollectionFlag()

Returns true if the resource is/was a collection - this flag is especially useful with DELETE events.

Returns:

true if the resource is/was a collection, false otherwise.

getSubClassName

String getSubClassName()

Returns the name of the interface of the "extended" resource event: The returned name is the name of the interface that extends IResourceEvent. If the event implements an additional interface which does not extend IResourceEvent then this method returns the class name. If the events class name is ResourceEvent then the return value is null (it was not an extended event).

Returns:

the name of the interface of the "extended" resource event.

getSendTime

long getSendTime()

Returns:

the time when the event was sent and persisted.

getAutoID

long getAutoID()

Returns:

a unique identifier for this event (primary key value of the row in the database table).