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


/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Purpose:
Contains a collection of RecordHeader objects.



Method Summary
  Options Name Purpose
  OpenEdge.Messaging.IHeaders Add (RecordHeader) /** Adds the given RecordHeader to the collection. @throw MessagingError if the collection is read-only, or the RecordHeader is not valid. @return returns this-object if successful. */
  IIterator <RecordHeader> GetIterator () /** Returns an iterator over the collection of record headers. */
  OpenEdge.Messaging.RecordHeader GetLastHeader (character) /** Retrieve the last header within the collection identified by the given key, if present. */
  OpenEdge.Messaging.IHeaders Remove (character) /** Removes the header for the given key from the collection. @throw MessagingError if the collection is read-only. @return this-object if successful. */
  OpenEdge.Messaging.RecordHeader ToArray () /** Returns the collection of record headers as an extent. */

Property Summary
  Options Name Purpose
  INTEGER Count
  LOGICAL IsReadOnly


Method Detail
Top

OpenEdge.Messaging.IHeaders Add (RecordHeader)

Purpose:
Adds the given RecordHeader to the collection.
@throw MessagingError if the collection is read-only, or the RecordHeader is not valid.
Parameters:
recordHeader OpenEdge.Messaging.RecordHeader
 
Returns OpenEdge.Messaging.IHeaders
  returns this-object if successful.
Top

IIterator <RecordHeader> GetIterator ()

Purpose:
Returns an iterator over the collection of record headers.
Returns IIterator <RecordHeader>
 
Top

OpenEdge.Messaging.RecordHeader GetLastHeader (character)

Purpose:
Retrieve the last header within the collection identified by the given key, if present.
Parameters:
key CHARACTER
 
Returns OpenEdge.Messaging.RecordHeader
 
Top

OpenEdge.Messaging.IHeaders Remove (character)

Purpose:
Removes the header for the given key from the collection.
@throw MessagingError if the collection is read-only.
Parameters:
key CHARACTER
 
Returns OpenEdge.Messaging.IHeaders
  this-object if successful.
Top

OpenEdge.Messaging.RecordHeader ToArray ()

Purpose:
Returns the collection of record headers as an extent.
Returns OpenEdge.Messaging.RecordHeader
 


Property Detail
Top

INTEGER Count

Returns INTEGER
 
Top

LOGICAL IsReadOnly

Returns LOGICAL