Classes in LDQ API
(”Write”)
Writer Class CL_LDQ_WRITER
Class CL_LDQ_WRITER is used to initialize the queue table when using the LDQ write functions. It implements interface IF_LDQ_WRITER.
UML Display:
Attribute Overview:
Attribute |
Visibility / Level |
Description |
M_APPLICATION_NAME |
Protected Instance |
LDQ Application Name |
Method Overview:
Method |
Visibility/Level |
Description |
SET_QUEUE_NAMES |
Public Instance |
The method creates an LDQ unit writer object. The method requires a table of LDQ queue names and returns an interface reference. |
Unit Writer Class CL_LDQ_UNIT_WRITER
Class CL_LDQ_UNIT_WRITER persists the LDQ queues in the database. The class implements interface IF_LDQ_UNIT_WRITER.
UML Display:
Attribute Overview:
Attribute |
Visibility / Level |
Description |
M_QUEUE_NAME_TAB |
Protected Instance |
Table of LDQ queue names. |
M_APPLICATION_NAME |
Protected Instance |
LDQ application name. |
M_QUEUE_NAMES_IN_ADMIN |
Protected Instance |
True if the table of LDQ queue names has been added to the administration table. |
C_ORDER_NUMBER |
Private Static |
Defines the order in which the units are created. |
C_APPLICATION_ADMIN_TAB |
Private Static |
Administration table for applications and queues. |
Method Overview:
Method |
Visibility/Level |
Description |
GET_NEXT_CONTENT |
Public Instance |
Create the content of the next unit. The method returns an interface reference. |
CONSTRUCTOR |
Public Instance |
Constructor. |
CLASS_CONSTRUCTOR |
Public Static |
Class constructor. |
ON_COMMIT |
Public Static |
Persist the created LDQ units in the database. |
ON_ROLLBACK |
Public Static |
Roll back the created LDQ units. |
AFTER_COMMIT |
Public Static |
Delete the internal tables. |
Unit Content Writer Class CL_LDQ_UNIT_CONTENT_WRITER
Class CL_LDQ_UNIT_CONTENT_WRITER writes a payload into the LDQ units. The class implements interface IF_LDQ_UNIT_CONTENT_WRITER.
UML Display:
No public or protected attributes.
Method Overview:
Method |
Visibility/Level |
Description |
SET_CDATA |
Public Instance |
The method writes character-like data. The method requires a character string. The method throws an exception if the unit is invalid. |
SET_XDATA |
Public Instance |
The method writes binary data. The method requires a byte string. |
GET_UNIT_ID |
Public Instance |
The method reads the current unit ID. |
SET_DESCRIPTION |
Public Instance |
The method writes additional description to the unit. The method requires a short character string.
If the character length of 255 is exceeded, the following characters are cut off. |
CONSTRUCTOR |
Public Instance |
Constructor. |
CLASS_CONSTRUCTOR |
Public Static |
Class constructor. |
