com.sap.sdm.api.remote
Interface Param

public interface Param

Represents a parameter. A parameter is a name-value pair, whereat the value is typed. Additionally, a Param contains recommendations on the representation of its value and type-specific access methods to its assigned value.

Version:

1.0

Method Summary

java.lang.String	getDisplayName() Returns the display name of the parameter.
java.lang.String	getName() Returns the name of the parameter.
ParamType	getType() Returns the type of the parameter.
boolean	getValueBoolean() Returns the value of Param objects with type ParamTypes.BOOLEAN.
byte	getValueByte() Returns the value of Param objects with type ParamTypes.BYTE.
double	getValueDouble() Returns the value of Param objects with type ParamTypes.DOUBLE.
float	getValueFloat() Returns the value of Param objects with type ParamTypes.FLOAT.
int	getValueInt() Returns the value of Param objects with type ParamTypes.INT.
long	getValueLong() Returns the value of Param objects with type ParamTypes.LONG.
java.lang.Object	getValueObject() Returns the value of this Param as Object.
short	getValueShort() Returns the value of Param objects with type ParamTypes.SHORT.
java.lang.String	getValueString() Returns the value of Param objects with type ParamTypes.STRING.
boolean	isValueSet() Indicates whether this Param contains a value different from null.
void	setValue(java.lang.Object paramValue) Sets the value of this Param as an Object.
boolean	valueShallBeHidden() Indicates whether to represent the value of this Param in clear text or not when exporting this Param to some external interface.

Method Detail

getName

public java.lang.String getName()
                         throws RemoteException

Returns the name of the parameter. The name of the parameter serves as an ID for the parameter.

Returns:

a String containing the name of the parameter

getDisplayName

public java.lang.String getDisplayName()
                                throws RemoteException

Returns the display name of the parameter. The display name of the parameter serves as an description for the parameter which could be used e.g. by graphical user interfaces.

Returns:

a String description of the name of the parameter

getType

public ParamType getType()
                  throws RemoteException

Returns the type of the parameter.

Returns:

a ParamType, representing the type of the parameter

See Also:

ParamType

getValueObject

public java.lang.Object getValueObject()
                                throws RemoteException

Returns the value of this Param as Object.

Returns:

an Object representation of the value of this Param; may be null

setValue

public void setValue(java.lang.Object paramValue)
              throws RemoteException

Sets the value of this Param as an Object.

Parameters:

paramValue - the value to be set as an Object, whereat null is an admitted value

isValueSet

public boolean isValueSet()
                   throws RemoteException

Indicates whether this Param contains a value different from null. For parameters of certain types, it is mandatory to check whether their value is different from null before invoking their type-specific value access methods.

Returns:

true if this Param contains a value different from null; false otherwise

valueShallBeHidden

public boolean valueShallBeHidden()
                           throws RemoteException

Indicates whether to represent the value of this Param in clear text or not when exporting this Param to some external interface.

Returns:

true if the value must not be represented in clear text; false otherwise

getValueString

public java.lang.String getValueString()
                                throws RemoteException

Returns the value of Param objects with type ParamTypes.STRING.

Returns:

the String value of this Param, which may be null

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.STRING

See Also:

ParamTypes.STRING

getValueBoolean

public boolean getValueBoolean()
                        throws RemoteException

Returns the value of Param objects with type ParamTypes.BOOLEAN.

Returns:

the boolean value of this Param

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.BOOLEAN, or if its value is null

See Also:

ParamTypes.BOOLEAN

getValueByte

public byte getValueByte()
                  throws RemoteException

Returns the value of Param objects with type ParamTypes.BYTE.

Returns:

the byte value of this Param

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.BYTE, or if its value is null

See Also:

ParamTypes.BYTE

getValueShort

public short getValueShort()
                    throws RemoteException

Returns the value of Param objects with type ParamTypes.SHORT.

Returns:

the short value of this Param

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.SHORT, or if its value is null

See Also:

ParamTypes.SHORT

getValueInt

public int getValueInt()
                throws RemoteException

Returns the value of Param objects with type ParamTypes.INT.

Returns:

the int value of this Param

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.INT, or if its value is null

See Also:

ParamTypes.INT

getValueLong

public long getValueLong()
                  throws RemoteException

Returns the value of Param objects with type ParamTypes.LONG.

Returns:

the long value of this Param

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.LONG, or if its value is null

See Also:

ParamTypes.LONG

getValueFloat

public float getValueFloat()
                    throws RemoteException

Returns the value of Param objects with type ParamTypes.FLOAT.

Returns:

the float value of this Param

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.FLOAT, or if its value is null

See Also:

ParamTypes.FLOAT

getValueDouble

public double getValueDouble()
                      throws RemoteException

Returns the value of Param objects with type ParamTypes.DOUBLE.

Returns:

the double value of this Param

Throws:

IllegalStateException - if the type of this Param is different from ParamTypes.DOUBLE, or if its value is null

See Also:

ParamTypes.DOUBLE