com.sapportals.wcm.repository.manager

Class IndexServiceAsyncWrapperEvent

java.lang.Object
  com.sapportals.wcm.repository.manager.IndexServiceAsyncWrapperEvent

All Implemented Interfaces:

IResourceEvent, IEvent

public final class IndexServiceAsyncWrapperEvent
extends Object
implements IResourceEvent

This event can be send if someone wants to send an asynchronous event to the index management service only.

Field Summary

static IndexServiceAsyncWrapperEvent	INDEX_SERVICE_ASYNC_WRAPPER_EVENT_TEMPLATE
static int	TYPE

Constructor Summary

IndexServiceAsyncWrapperEvent(IResource resource)
Used to asynchronously inform the indexmanagment to index a resource.

Method Summary

String	getDescription()
String	getDescription(Locale locale)
Object	getParameter() Returns the event's parameter
IResource	getResource() Get a reference to the IResource , that caused the event.
int	getType() Returns the event's type
boolean	isLike(IEvent template) Compares this event with another event for equality or some kind of "similarity".

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_SERVICE_ASYNC_WRAPPER_EVENT_TEMPLATE

public static final IndexServiceAsyncWrapperEvent INDEX_SERVICE_ASYNC_WRAPPER_EVENT_TEMPLATE

TYPE

public static final int TYPE

See Also:

Constant Field Values

Constructor Detail

IndexServiceAsyncWrapperEvent

public IndexServiceAsyncWrapperEvent(IResource resource)
                              throws com.sapportals.wcm.WcmException

Used to asynchronously inform the indexmanagment to index a resource.

Parameters:

resource -

index -

Throws:

com.sapportals.wcm.WcmException

Method Detail

getResource

public IResource getResource()

Description copied from interface: IResourceEvent

Get a reference to the IResource , that caused the event.

Specified by:

getResource in interface IResourceEvent

Returns:

IResource Resource, that caused the event.

getType

public int getType()

Description copied from interface: IEvent

Returns the event's type

Specified by:

getType in interface IEvent

Returns:

the event's type

getParameter

public Object getParameter()

Description copied from interface: IEvent

Returns the event's parameter

Specified by:

getParameter in interface IEvent

Returns:

the event's parameter

isLike

public boolean isLike(IEvent template)

Description copied from interface: IEvent

Compares this event with another event for equality or some kind of "similarity". Normally an event equals another if it is of the same instance and type. There might be implementations that want to match one event type with many others.

Specified by:

isLike in interface IEvent

Parameters:

template - The other event to compare with.

Returns:

True, if the specified event template is equal to this event, according to the implemented matching rules.

getDescription

public String getDescription()

Specified by:

getDescription in interface IEvent

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface IEvent

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