com.sapportals.wcm.service.actioninbox

Interface IActionInboxAction

All Known Implementing Classes:

AbstractActionInboxAction

public interface IActionInboxAction

The IActionInboxAction defines an action which can be performed for an item and is handled by a producer.

Copyright 2004 SAP AG

Method Summary

String	getDescription(Locale locale) Get the action's (displayable) description.
String	getName() Get the action's name.
String	getNamespace() Get the action's namespace.
Properties	getProperties() Get the action's properties.
String	getType() Get the action's type.

Method Detail

getNamespace

String getNamespace()

Get the action's namespace.

Returns:

a String with the namespace of this action.

getType

String getType()

Get the action's type.

Returns:

a String with the type of this action.

getName

String getName()

Get the action's name.

Returns:

a String with the name of this action. this name has to be unique (per producer).

getDescription

String getDescription(Locale locale)

Get the action's (displayable) description.

Parameters:

locale - a Locale with the preferred language to get the description for.

Returns:

a String with the description for this action.

getProperties

Properties getProperties()

Get the action's properties.

Returns:

a bag of Properties for this action.

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