de.softdevel.d1.datapool

Class CRecordNotifyDatapoolValueChanged

java.lang.Object

de.softdevel.d1.datapool.CRecordNotifyDatapoolValueChanged

public final class CRecordNotifyDatapoolValueChanged
extends java.lang.Object

Notification that a data pool value has been changed.

Field Summary

Fields

Modifier and Type	Field and Description
static IId	ID Message ID.
static ISlotKey	SLOT_DESCRIPTION Slot DESCRIPTION data type = STRING mandatory = true answer = false The record description.
static ISlotKey	SLOT_KEY Slot KEY data type = STRING mandatory = true answer = false The key.
static ISlotKey	SLOT_PATH Slot PATH data type = STRING mandatory = true answer = false The path.
static ISlotKey	SLOT_VALUE Slot VALUE data type = STRING mandatory = true answer = false The value.

Method Summary

Modifier and Type	Method and Description
static CRecord	create() Create Record with this ID.
static java.lang.String	getParamDescription(CRecord aRecord, java.lang.String aDefault) The record description.
static java.lang.String	getParamKey(CRecord aRecord, java.lang.String aDefault) The key.
static java.lang.String	getParamPath(CRecord aRecord, java.lang.String aDefault) The path.
static java.lang.String	getParamValue(CRecord aRecord, java.lang.String aDefault) The value.
static void	setParamDescription(CRecord aRecord, java.lang.String aValue) The record description.
static void	setParamKey(CRecord aRecord, java.lang.String aValue) The key.
static void	setParamPath(CRecord aRecord, java.lang.String aValue) The path.
static void	setParamValue(CRecord aRecord, java.lang.String aValue) The value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final IId ID

Message ID.

SLOT_DESCRIPTION

public static final ISlotKey SLOT_DESCRIPTION

Slot DESCRIPTION
data type = STRING
mandatory = true
answer = false
The record description.

SLOT_KEY

public static final ISlotKey SLOT_KEY

Slot KEY
data type = STRING
mandatory = true
answer = false
The key.

SLOT_PATH

public static final ISlotKey SLOT_PATH

Slot PATH
data type = STRING
mandatory = true
answer = false
The path.

SLOT_VALUE

public static final ISlotKey SLOT_VALUE

Slot VALUE
data type = STRING
mandatory = true
answer = false
The value.

Method Detail

create

public static CRecord create()

Create Record with this ID.

Returns:

The record with this ID.

getParamDescription

public static java.lang.String getParamDescription(CRecord aRecord,
                                                   java.lang.String aDefault)

The record description.

Parameters:

aRecord - The record.

aDefault - Default value, if slot (data) not found.

Returns:

The value if found, otherwise the default value.

getParamKey

public static java.lang.String getParamKey(CRecord aRecord,
                                           java.lang.String aDefault)

The key.

Parameters:

aRecord - The record.

aDefault - Default value, if slot (data) not found.

Returns:

The value if found, otherwise the default value.

getParamPath

public static java.lang.String getParamPath(CRecord aRecord,
                                            java.lang.String aDefault)

The path.

Parameters:

aRecord - The record.

aDefault - Default value, if slot (data) not found.

Returns:

The value if found, otherwise the default value.

getParamValue

public static java.lang.String getParamValue(CRecord aRecord,
                                             java.lang.String aDefault)

The value.

Parameters:

aRecord - The record.

aDefault - Default value, if slot (data) not found.

Returns:

The value if found, otherwise the default value.

setParamDescription

public static void setParamDescription(CRecord aRecord,
                                       java.lang.String aValue)
                                throws CException

The record description.

Parameters:

aRecord - The record.

aValue - The value to set.

Throws:

CException - on parsing the value.

setParamKey

public static void setParamKey(CRecord aRecord,
                               java.lang.String aValue)
                        throws CException

The key.

Parameters:

aRecord - The record.

aValue - The value to set.

Throws:

CException - on parsing the value.

setParamPath

public static void setParamPath(CRecord aRecord,
                                java.lang.String aValue)
                         throws CException

The path.

Parameters:

aRecord - The record.

aValue - The value to set.

Throws:

CException - on parsing the value.

setParamValue

public static void setParamValue(CRecord aRecord,
                                 java.lang.String aValue)
                          throws CException

The value.

Parameters:

aRecord - The record.

aValue - The value to set.

Throws:

CException - on parsing the value.