com.sapportals.wcm.repository.manager

Class VariantResourceEvent

java.lang.Object
  com.sapportals.wcm.repository.manager.ResourceEvent
      com.sapportals.wcm.repository.manager.VariantResourceEvent

All Implemented Interfaces:

IResourceEvent, IVariantResourceEvent, IEvent

public class VariantResourceEvent
extends ResourceEvent
implements IVariantResourceEvent

Implementation of a variant resource event.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sapportals.wcm.repository.variants.IVariantResourceEvent

IVariantResourceEvent.EVENT_SUB_TYPE

Field Summary

Fields inherited from class com.sapportals.wcm.repository.manager.ResourceEvent

ACL_CHANGED, ACL_CHANGED_TEMPLATE, ALL, ALL_TEMPLATE, CHECKIN, CHECKIN_TEMPLATE, CHECKOUT, CHECKOUT_TEMPLATE, clientId, COPY, COPY_TEMPLATE, correlationId, CREATE_CHILD, CREATE_CHILD_TEMPLATE, CREATE_COLLECTION, CREATE_COLLECTION_TEMPLATE, CREATE_LINK, CREATE_LINK_TEMPLATE, DELETE, DELETE_TEMPLATE, ENABLE_VERSIONING, ENABLE_VERSIONING_TEMPLATE, GET, GET_CHILDREN, GET_CHILDREN_TEMPLATE, GET_TEMPLATE, LOCK, LOCK_TEMPLATE, MIGRATION, MIGRATION_TEMPLATE, MOVE, MOVE_TEMPLATE, param, PRE_CHECK_NAME, PRE_CHECK_NAME_TEMPLATE, PRE_CHECK_OUT, PRE_CHECK_OUT_TEMPLATE, PRE_CHECKIN, PRE_CHECKIN_TEMPLATE, PRE_CREATE_COLLECTION, PRE_CREATE_COLLECTION_TEMPLATE, PRE_CREATE_LINK, PRE_CREATE_LINK_TEMPLATE, PRE_CREATE_RESOURCE, PRE_CREATE_RESOURCE_TEMPLATE, PRE_DELETE, PRE_DELETE_TEMPLATE, PRE_ENABLE_VESIONING, PRE_ENABLE_VESIONING_TEMPLATE, PRE_LOCK, PRE_LOCK_TEMPLATE, PRE_MOVE, PRE_MOVE_TEMPLATE, PRE_PROPERTY_DELETE, PRE_PROPERTY_DELETE_TEMPLATE, PRE_PROPERTY_SET, PRE_PROPERTY_SET_TEMPLATE, PRE_RENAME, PRE_RENAME_TEMPLATE, PRE_SET, PRE_SET_TEMPLATE, PRE_UPDATE_LINK, PRE_UPDATE_LINK_TEMPLATE, PROPERTY_DELETE, PROPERTY_DELETE_TEMPLATE, PROPERTY_GET, PROPERTY_GET_TEMPLATE, PROPERTY_SET, PROPERTY_SET_TEMPLATE, RENAME, RENAME_TEMPLATE, resource, resourceContext, SET, SET_TEMPLATE, type, UNDO_CHECKOUT, UNDO_CHECKOUT_TEMPLATE, uniqueId, UNLOCK, UNLOCK_TEMPLATE, UPDATE_LINK, UPDATE_LINK_TEMPLATE

Constructor Summary

VariantResourceEvent(IResource resource, int type, String correlationId, Object param, int subType, IResource physicalResource)

Method Summary

IResource	getPhysicalResource() Returns the phsysical resource attached to this event or null.
int	getPhysicalResourceEventSubType() Returns the event sub-type indicating the operation performed on the physical resource if the event type is ResourceEvent.SET.

Methods inherited from class com.sapportals.wcm.repository.manager.ResourceEvent

getClientId, getCorrelationId, getDescription, getDescription, getParameter, getReceiverProperty, getResource, getResourceContext, getType, getUniqueId, isLike, setReceiverProperty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sapportals.wcm.repository.manager.IResourceEvent

getResource

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

getDescription, getDescription, getParameter, getType, isLike

Constructor Detail

VariantResourceEvent

public VariantResourceEvent(IResource resource,
                            int type,
                            String correlationId,
                            Object param,
                            int subType,
                            IResource physicalResource)

Parameters:

resource -

type -

correlationId -

param -

subType - One of the sub-type values defined in IVariantResourceEvent.EVENT_SUB_TYPE.

physicalResource - The physical resource which was modified as indicated by the sub-type.

See Also:

ResourceEvent.ResourceEvent(IResource, int, String, Object)

Method Detail

getPhysicalResource

public IResource getPhysicalResource()

Description copied from interface: IVariantResourceEvent

Returns the phsysical resource attached to this event or null. Note: This is not always the same physical resource associated with the logical resource of this event.
Depending on the type and sub-type of this event the return value has the following meaning:

• ResourceEvent.CREATE_CHILD: The first physical resources created together with a logical resource.
• ResourceEvent.SET: The created, updated or deleted physical resource - see also IVariantResourceEvent.getPhysicalResourceEventSubType().
• ResourceEvent.PROPERTY_SET, ResourceEvent.PROPERTY_DELETE: The physical resource whose properties have been updated.
• ResourceEvent.DELETE: null (all physical resources are deleted when the logical resource is deleted).

Specified by:

getPhysicalResource in interface IVariantResourceEvent

Returns:

the phsysical resource attached to this event.

getPhysicalResourceEventSubType

public int getPhysicalResourceEventSubType()

Description copied from interface: IVariantResourceEvent

Returns the event sub-type indicating the operation performed on the physical resource if the event type is ResourceEvent.SET.

Specified by:

getPhysicalResourceEventSubType in interface IVariantResourceEvent

Returns:

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