com.sapportals.wcm.service.reporting

Interface IReportCommand

public interface IReportCommand

Represents a command which can be executed in a certain report.

Copyright (c) SAP AG 2003

Method Summary

String	getDescription(Locale locale) Get description of report command with given locale.
String	getDisplayName(Locale locale) Get name suitable for display to the user.
IReportInputMeta	getMeta() Get meta information about input to this command
com.sapportals.wcm.util.name.IName	getName() Get name of this command

Method Detail

getName

com.sapportals.wcm.util.name.IName getName()

Get name of this command

Returns:

name of command

getDisplayName

String getDisplayName(Locale locale)

Get name suitable for display to the user. The display name might not be unique.

Parameters:

locale - to get name for

Returns:

name for given locale

getDescription

String getDescription(Locale locale)

Get description of report command with given locale.

Parameters:

locale - to get description for

Returns:

description for locale

getMeta

IReportInputMeta getMeta()
                         throws ResourceException

Get meta information about input to this command

Returns:

meta information about input to this command

Throws:

ResourceException

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