com.sapportals.wcm.repository.service.statemanagement.cm

Class StatemanagementEvent

java.lang.Object
  com.sapportals.wcm.repository.service.statemanagement.cm.StatemanagementEvent

All Implemented Interfaces:

IResourceEvent, IStatemanagementEvent, IEvent

public class StatemanagementEvent
extends Object
implements IStatemanagementEvent

The implementation of the IStatemanagementEvent which is send to inform about state changes.

Field Summary

static StatemanagementEvent	ARCHIVE_TEMPLATE
static StatemanagementEvent	BACK_IN_PROGRESS_TEMPLATE
static StatemanagementEvent	PRE_ARCHIVE_TEMPLATE
static StatemanagementEvent	PRE_BACK_IN_PROGRESS_TEMPLATE
static StatemanagementEvent	PRE_PUBLISH_TEMPLATE The event templates
static StatemanagementEvent	PUBLISH_TEMPLATE

Fields inherited from interface com.sapportals.wcm.repository.service.statemanagement.IStatemanagementEvent

ALL, ARCHIVE, BACK_IN_PROGRESS, PRE_ARCHIVE, PRE_BACK_IN_PROGRESS, PRE_PUBLISH, PUBLISH

Constructor Summary

StatemanagementEvent(int aType, IResource aResource)
Construct object of class StatemanagementEvent.

Method Summary

String	getDescription() Get the Description attribute of the StatemanagementEvent object.
String	getDescription(Locale locale) Get the Description attribute of the StatemanagementEvent object.
String	getName() Deprecated. as of NW04. Please use getType() or getDescription()
Object	getParameter() Get the Parameter attribute of the StatemanagementEvent object.
IResource	getResource() Get the Resource attribute of the StatemanagementEvent object.
int	getType() Get the Type attribute of the StatemanagementEvent object.
boolean	isLike(IEvent template) Compares the event to a template event like isInstanceOf()
boolean	isSemanticEvent() Get the SemanticEvent attribute of the StatemanagementEvent object.

Methods inherited from class java.lang.Object

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

Field Detail

PRE_PUBLISH_TEMPLATE

public static final StatemanagementEvent PRE_PUBLISH_TEMPLATE

The event templates

PRE_ARCHIVE_TEMPLATE

public static final StatemanagementEvent PRE_ARCHIVE_TEMPLATE

PRE_BACK_IN_PROGRESS_TEMPLATE

public static final StatemanagementEvent PRE_BACK_IN_PROGRESS_TEMPLATE

PUBLISH_TEMPLATE

public static final StatemanagementEvent PUBLISH_TEMPLATE

ARCHIVE_TEMPLATE

public static final StatemanagementEvent ARCHIVE_TEMPLATE

BACK_IN_PROGRESS_TEMPLATE

public static final StatemanagementEvent BACK_IN_PROGRESS_TEMPLATE

Constructor Detail

StatemanagementEvent

public StatemanagementEvent(int aType,
                            IResource aResource)

Construct object of class StatemanagementEvent.

Parameters:

aType - The type of the event as defined int IStatemanagementEvent

aResource - The resource to send the event for

Method Detail

isLike

public boolean isLike(IEvent template)

Compares the event to a template event like isInstanceOf()

Specified by:

isLike in interface IEvent

Parameters:

template - the template event to compare this event to

Returns:

The Like value

getResource

public IResource getResource()

Get the Resource attribute of the StatemanagementEvent object.

Specified by:

getResource in interface IResourceEvent

Returns:

The Resource value

getName

public String getName()

Deprecated. as of NW04. Please use getType() or getDescription()

Returns:

The Name value

getDescription

public String getDescription()

Get the Description attribute of the StatemanagementEvent object.

Specified by:

getDescription in interface IEvent

Returns:

The Description value

getDescription

public String getDescription(Locale locale)

Get the Description attribute of the StatemanagementEvent object.

Specified by:

getDescription in interface IEvent

Parameters:

locale - the locale to use for the language dependent description

Returns:

A language dependet description of the event

getType

public int getType()

Get the Type attribute of the StatemanagementEvent object.

Specified by:

getType in interface IEvent

Returns:

The Type value

getParameter

public Object getParameter()

Get the Parameter attribute of the StatemanagementEvent object.

Specified by:

getParameter in interface IEvent

Returns:

The Parameter value

isSemanticEvent

public boolean isSemanticEvent()

Get the SemanticEvent attribute of the StatemanagementEvent object.

Returns:

The SemanticEvent value

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