Namespace: OpenEdge.Messaging
Class
ProducerRecord
Parent classes:
Progress.Lang.Object
OpenEdge.Messaging.ProducerRecord

Inherits: Progress.Lang.Object
Implements: OpenEdge.Messaging.IProducerRecord

/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Purpose:
This is basic implementation of producer record. Specific implementations
of messaging libraries are free to extend this if necessary and add additional
properties.




Method Summary
Options Name Purpose
Progress.Lang.Object GetOption (character) /** Retrieve a option value by its name. @param name The name of the option to retrieve. @return The value of an option that has been stored with the record. */
CHARACTER GetOptionNames () /** Returns an array of the option names that have been configured for this record. @return A character array of option names that are stored by the record. */
LOGICAL HasOption (character) /** Returns true if the named record option has been set. @param name The name of the option to find. @return Returns true if this record has an option with the given name. */

Constructor Summary
Options Name Purpose
ProducerRecord () /** Construct a new ProducerRecord with default set of options. No topic is configured by default. */
ProducerRecord (character) /** Construct a new ProducerRecord for the given topic. @param topicName The destination topic for the record. */
ProducerRecord (character, IStringKeyedMap) /** Construct a new ProducerRecord for the given topic with the given option. @param topicName The destination topic for the record. @param options A map of options for the record. */

Property Summary
Options Name Purpose
Progress.Lang.Object Body
OpenEdge.Messaging.IHeaders Headers
INTEGER PartitionId
Progress.Lang.Object PartitionKey
DATETIME-TZ Timestamp
CHARACTER TopicName


Method Detail
Top

Progress.Lang.Object GetOption (character)
Purpose:
Retrieve a option value by its name.
Parameters:
name CHARACTER
The name of the option to retrieve.
Returns Progress.Lang.Object
The value of an option that has been stored with the record.
Top

CHARACTER GetOptionNames ()
Purpose:
Returns an array of the option names that have been configured for this record.
Returns CHARACTER
A character array of option names that are stored by the record.
Top

LOGICAL HasOption (character)
Purpose:
Returns true if the named record option has been set.
Parameters:
name CHARACTER
The name of the option to find.
Returns LOGICAL
Returns true if this record has an option with the given name.


Constructor Detail
Top

ProducerRecord ()
Purpose:
Construct a new ProducerRecord with default set of options.
No topic is configured by default.
Top

ProducerRecord (character)
Purpose:
Construct a new ProducerRecord for the given topic.
Parameters:
topicName CHARACTER
The destination topic for the record.
Top

ProducerRecord (character, IStringKeyedMap)
Purpose:
Construct a new ProducerRecord for the given topic with the given option.
Parameters:
topicName CHARACTER
The destination topic for the record.
options OpenEdge.Core.Collections.IStringKeyedMap
A map of options for the record.


Property Detail
Top

Progress.Lang.Object Body
Returns Progress.Lang.Object
Top

OpenEdge.Messaging.IHeaders Headers
Returns OpenEdge.Messaging.IHeaders
Top

INTEGER PartitionId
Returns INTEGER
Top

Progress.Lang.Object PartitionKey
Returns Progress.Lang.Object
Top

DATETIME-TZ Timestamp
Returns DATETIME-TZ
Top

CHARACTER TopicName
Returns CHARACTER


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.5.0