Show TOC

Classes in the LDQ API - "Write"Locate this document in the navigation structure

Use

Writer Class CL_LDQ_WRITER

The class CL_LDQ_WRITER serves to initialize the table of queues for the LDQ writing use case. It implements the interface IF_LDQ_WRITER.

UML Representation:

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

The class CL_LDQ_UNIT_WRITER persists the LDQ queues in the database. The class implements the interface IF_LDQ_UNIT_WRITER.

UML Representation:

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 when table of LDQ queue names was added to administration table.

C_ORDER_NUMBER

Private Static

Define Order of Unit Generation.

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 next unit's content. 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

The class CL_LDQ_UNIT_CONTENT_WRITER writes a payload into LDQ units. The class implements the interface IF_LDQ_UNIT_CONTENT_WRITER.

UML Representation:

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.

Note

If a string contains more than 255 characters, the remaining characters are cut off.

CONSTRUCTOR

Public Instance

Constructor.

CLASS_CONSTRUCTOR

Public Static

Class Constructor