com.sap.tc.webdynpro.progmodel.api
Interface IWDController

All Known Subinterfaces:

IWDComponent, IWDView, IWDViewController

public interface IWDController

Generic API of all Web Dynpro controllers. All controllers created by the Web Dynpro toolset implement this interface. Unless explicitly stated, the methods listed for this interface are not available to parent components through the component usage interface.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_progmodel/java/com/sap/tc/webdynpro/progmodel/api/IWDController.java#2 $

Method Summary

IWDAction	getAction(java.lang.String name) Returns the action with name name or null.
IWDComponent	getComponent() Returns the component this controller belongs to.
IWDContext	getContext() Returns the context of this controller.
IWDControllerInfo	getControllerInfo() Returns the metadata describing this controller.
java.lang.String	getMessage(java.lang.String key) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).
java.lang.String	getMessage(java.lang.String key, java.lang.Object[] parameters) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String, Object[]) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).
java.lang.String	getName() Returns the name of this controller.
java.lang.String	getPackageName() Returns the package part of the qualified name of this controller.
java.lang.String	getQualifiedName() Returns the qualified name of this controller.
java.lang.String	getText(java.lang.String key) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).
java.lang.String	getText(java.lang.String key, java.lang.Object[] parameters) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String, Object[]) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).

Method Detail

getAction

public IWDAction getAction(java.lang.String name)

Returns the action with name name or null.

Parameters:

name - name of the action to be returned

Returns:

requesed action or null, if it does not exist

getComponent

public IWDComponent getComponent()

Returns the component this controller belongs to.

Returns:

the component this controller belongs to

getContext

public IWDContext getContext()

Returns the context of this controller. This method is visible through the component usage interface.

Returns:

the context of this controller

getControllerInfo

public IWDControllerInfo getControllerInfo()

Returns the metadata describing this controller.

Returns:

the controller metadata object

getMessage

public java.lang.String getMessage(java.lang.String key)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).

Returns a localized message text for the given key.

Parameters:

key - the key of the localized message

Returns:

the localized message text

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] parameters)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String, Object[]) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).

Returns a message text corresponding to key that is both localized, and formatted according to parameters.

Parameters:

key - the key of the localized message

parameters - object array of parameters

Returns:

a localized message text

getText

public java.lang.String getText(java.lang.String key)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).

Returns a localized message text for the given key.

Parameters:

key - the key of the localized text

Returns:

the localized message text

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.Object[] parameters)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. Use IWDTextAccessor.getText(String, Object[]) instead (see IWDComponent.getTextAccessor() on how to get access to an IWDTextAccessor).

Returns a message text corresponding to key that is both localized, and formatted according to parameters.

Parameters:

key - the key of the localized text

parameters - object array of parameters

Returns:

the message text

getName

public java.lang.String getName()

Returns the name of this controller.

Returns:

the name of this controller

getPackageName

public java.lang.String getPackageName()

Returns the package part of the qualified name of this controller.

Returns:

the package part of the qualified name of this controller

getQualifiedName

public java.lang.String getQualifiedName()

Returns the qualified name of this controller.

Returns:

the qualified name of this controller