Namespace: OpenEdge.Messaging
Type: Interface IProducerRecord
Parent Classes:
Inherits: Progress.Lang.Object

/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Purpose:
The partition key us used to select the topic partition where the record will be sent.
This is only used if the underlying messaging implementation supports topic partitioning based on
partition keys. Often the partition key is hashed and the result is used to select the final
partition. If the partition id is assigned, then the partition id will be used instead of the
partition key. If both are left as th UNKNOWN value, then the producer implementation
is free to select a destination partition.



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 option value. */
  CHARACTER GetOptionNames () /** Returns an array of the option names that have been configured for this record. @return A character array of option names that have been stored for the record. */
  LOGICAL HasOption (character) /** Returns true if the named record option has been set. @param name The name of the option. @return True if an option value has been stored for the given name. */

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 option value.
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 have been stored for 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.
Returns LOGICAL
  True if an option value has been stored for the given name.


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