com.sapportals.wcm.repository.service.discussion.wcm

Class DiscussionEvent

java.lang.Object
  com.sapportals.wcm.repository.service.discussion.wcm.DiscussionEvent

All Implemented Interfaces:

IResourceEvent, IDiscussionEvent, IEvent

public class DiscussionEvent
extends Object
implements IDiscussionEvent

The interface DiscussionEvent defines constants for all events that the discussion service uses when it creates or deletes different types of discussion objects.
The events sent by the discussion service are necessary for the subscription service which needs to know when discussions are created, changed or deleted. Copyright 2004 SAP AG

Field Summary

static DiscussionEvent	CHANGE_DISCUSSION_ITEM_TEMPLATE
static DiscussionEvent	CHANGE_DISCUSSION_TEMPLATE
static DiscussionEvent	DELETE_DISCUSSION_ITEM_TEMPLATE
static DiscussionEvent	DELETE_DISCUSSION_TEMPLATE
static DiscussionEvent	NEW_DISCUSSION_ITEM_TEMPLATE
static DiscussionEvent	NEW_DISCUSSION_TEMPLATE
static DiscussionEvent	PRE_CHANGE_DISCUSSION_ITEM_TEMPLATE
static DiscussionEvent	PRE_CHANGE_DISCUSSION_TEMPLATE The event templates
static DiscussionEvent	PRE_DELETE_DISCUSSION_ITEM_TEMPLATE
static DiscussionEvent	PRE_DELETE_DISCUSSION_TEMPLATE

Fields inherited from interface com.sapportals.wcm.repository.service.discussion.IDiscussionEvent

CHANGE_DISCUSSION, CHANGE_DISCUSSION_ITEM, DELETE_DISCUSSION, DELETE_DISCUSSION_ITEM, NEW_DISCUSSION, NEW_DISCUSSION_ITEM, PRE_CHANGE_DISCUSSION, PRE_CHANGE_DISCUSSION_ITEM, PRE_DELETE_DISCUSSION, PRE_DELETE_DISCUSSION_ITEM

Constructor Summary

DiscussionEvent(int aType, IResource aResource)

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".
boolean	isSemanticEvent()

Methods inherited from class java.lang.Object

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

Field Detail

PRE_CHANGE_DISCUSSION_TEMPLATE

public static final DiscussionEvent PRE_CHANGE_DISCUSSION_TEMPLATE

The event templates

PRE_CHANGE_DISCUSSION_ITEM_TEMPLATE

public static final DiscussionEvent PRE_CHANGE_DISCUSSION_ITEM_TEMPLATE

PRE_DELETE_DISCUSSION_TEMPLATE

public static final DiscussionEvent PRE_DELETE_DISCUSSION_TEMPLATE

PRE_DELETE_DISCUSSION_ITEM_TEMPLATE

public static final DiscussionEvent PRE_DELETE_DISCUSSION_ITEM_TEMPLATE

NEW_DISCUSSION_TEMPLATE

public static final DiscussionEvent NEW_DISCUSSION_TEMPLATE

NEW_DISCUSSION_ITEM_TEMPLATE

public static final DiscussionEvent NEW_DISCUSSION_ITEM_TEMPLATE

CHANGE_DISCUSSION_TEMPLATE

public static final DiscussionEvent CHANGE_DISCUSSION_TEMPLATE

CHANGE_DISCUSSION_ITEM_TEMPLATE

public static final DiscussionEvent CHANGE_DISCUSSION_ITEM_TEMPLATE

DELETE_DISCUSSION_TEMPLATE

public static final DiscussionEvent DELETE_DISCUSSION_TEMPLATE

DELETE_DISCUSSION_ITEM_TEMPLATE

public static final DiscussionEvent DELETE_DISCUSSION_ITEM_TEMPLATE

Constructor Detail

DiscussionEvent

public DiscussionEvent(int aType,
                       IResource aResource)

Method Detail

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.

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.

getDescription

public String getDescription()

Specified by:

getDescription in interface IEvent

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface IEvent

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

isSemanticEvent

public boolean isSemanticEvent()

Access Rights

This class can be accessed from:

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