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

public interface IWDCustomEvent

API of Custom Events provided to Controller Event Handlers.

Version:

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

Method Summary

boolean	getBoolean(java.lang.String name) Returns the specified parameter as a boolean value.
byte	getByte(java.lang.String name) Returns the specified parameter as a byte value.
char	getChar(java.lang.String name) Returns the specified parameter as a char value.
double	getDouble(java.lang.String name) Returns the specified parameter as a double value.
float	getFloat(java.lang.String name) Returns the specified parameter as a float value.
int	getInt(java.lang.String name) Returns the specified parameter as a integer value.
long	getLong(java.lang.String name) Returns the specified parameter as a long value.
java.lang.String	getName() Returns the name of the event.
java.lang.Object	getObject(java.lang.String name) Returns the specified parameter as an Object.
java.lang.Object	getObject(java.lang.String name, java.lang.Class clazz) Returns the specified parameter as an Object of type clazz.
short	getShort(java.lang.String name) Returns the specified parameter as a short value.
java.lang.String	getString(java.lang.String name) Returns the specified parameter as a string value.

Method Detail

getName

public java.lang.String getName()

Returns the name of the event.

Returns:

the name of the event

getBoolean

public boolean getBoolean(java.lang.String name)

Returns the specified parameter as a boolean value. Throws a runtime exception if the parameter is not a boolean or String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or false if it does not exist)

getByte

public byte getByte(java.lang.String name)

Returns the specified parameter as a byte value. Throws a runtime exception if the parameter is not a byte or String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or 0 if it does not exist)

getChar

public char getChar(java.lang.String name)

Returns the specified parameter as a char value. Throws a runtime exception if the parameter is not a char or one character String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or 0 if it does not exist)

getDouble

public double getDouble(java.lang.String name)

Returns the specified parameter as a double value. Throws a runtime exception if the parameter is not a double or String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or 0 if it does not exist)

getFloat

public float getFloat(java.lang.String name)

Returns the specified parameter as a float value. Throws a runtime exception if the parameter is not a float or String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or 0 if it does not exist)

getInt

public int getInt(java.lang.String name)

Returns the specified parameter as a integer value. Throws a runtime exception if the parameter is not an int or String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or 0 if it does not exist)

getLong

public long getLong(java.lang.String name)

Returns the specified parameter as a long value. Throws a runtime exception if the parameter is not a long or String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or 0 if it does not exist)

getObject

public java.lang.Object getObject(java.lang.String name)

Returns the specified parameter as an Object.

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or null if it does not exist or is null)

getObject

public java.lang.Object getObject(java.lang.String name,
                                  java.lang.Class clazz)

Returns the specified parameter as an Object of type clazz. Throws a runtime exception if the parameter cannot be converted to the specified type.

Parameters:

name - the name of the parameter to retrieve

class - class object of desired conversion

Returns:

the parameter value (or null if it does not exist or is null)

getShort

public short getShort(java.lang.String name)

Returns the specified parameter as a short value. Throws a runtime exception if the parameter is not a short or String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or 0 if it does not exist)

getString

public java.lang.String getString(java.lang.String name)

Returns the specified parameter as a string value. Throws a runtime exception if the parameter is not a String

Parameters:

name - the name of the parameter to retrieve

Returns:

the parameter value (or null if it does not exist or is null)