Namespace: OpenEdge.Messaging
Type: Class Headers
Parent Classes:
Progress.Lang.Object
OpenEdge.Messaging.Headers

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

/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Purpose:
This is the default implementation of IHeaders.



Method Summary
  Options Name Purpose
  OpenEdge.Messaging.IHeaders Add (RecordHeader) /** Add a header to the collection. @param recordHeader The header to add. @return this Headers collection */
  CheckReadOnly () /** Check if the collection is readonly. To be called before any modification to the collection is performed. @throws MessagingError if the collection is readonly */
  IIterator <RecordHeader> GetIterator () /** Return an iterator over the collection */
  OpenEdge.Messaging.RecordHeader GetLastHeader (character) /** Return the last header in the collection that matches the given key @return the last record header, if any, found in the collection with the given key. */
  OpenEdge.Messaging.IHeaders Remove (character) /** Remove all headers from the collection that have the given key. @param key the key to select which headers to remove. @return this Headers collection. */
  SetReadOnly () /** Make this collection of headers read-only. This is a one-way operation and there is no method to set the collection back to being read-write. */
  OpenEdge.Messaging.RecordHeader ToArray () /** Convert the list to an array. @return An array containing the record headers from the collection. */

Constructor Summary
  Options Name Purpose
  Headers () /** Construct an empty Headers collection. */
  Headers (IHeaders, logical) /** Construct a Headers collection and copy the contents of the other headers collection. to the internal collection. The collection is optionally marked as read-only. */
  Headers (logical) /** Construct an empty Headers collection, optionally marking the collection as read-only. */
  Headers (RecordHeader[]) /** Construct a Headers collection and copy of contents of the array to the internal collection. */
  Headers (RecordHeader[], logical) /** Construct a Headers collection and copy the contents of the array to the internal collection. The collection is optionally marked as read-only. */

Property Summary
  Options Name Purpose
  INTEGER Count
  LOGICAL IsReadOnly


Method Detail
Top

OpenEdge.Messaging.IHeaders Add (RecordHeader)

Purpose:
Add a header to the collection.
Parameters:
recordHeader OpenEdge.Messaging.RecordHeader
  The header to add.
Returns OpenEdge.Messaging.IHeaders
  this Headers collection
Top

CheckReadOnly ()

Purpose:
Check if the collection is readonly. To be called
before any modification to the collection is performed.
@throws MessagingError if the collection is readonly
Top

IIterator <RecordHeader> GetIterator ()

Purpose:
Return an iterator over the collection
Returns IIterator <RecordHeader>
 
Top

OpenEdge.Messaging.RecordHeader GetLastHeader (character)

Purpose:
Return the last header in the collection that matches the given key
Parameters:
key CHARACTER
 
Returns OpenEdge.Messaging.RecordHeader
  the last record header, if any, found in the collection with the given key.
Top

OpenEdge.Messaging.IHeaders Remove (character)

Purpose:
Remove all headers from the collection that have the given key.
Parameters:
key CHARACTER
  the key to select which headers to remove.
Returns OpenEdge.Messaging.IHeaders
  this Headers collection.
Top

SetReadOnly ()

Purpose:
Make this collection of headers read-only. This is a one-way operation
and there is no method to set the collection back to being read-write.
Top

OpenEdge.Messaging.RecordHeader ToArray ()

Purpose:
Convert the list to an array.
Returns OpenEdge.Messaging.RecordHeader
  An array containing the record headers from the collection.


Constructor Detail
Top

Headers ()

Purpose:
Construct an empty Headers collection.
Top

Headers (IHeaders, logical)

Purpose:
Construct a Headers collection and copy the contents of the other headers collection.
to the internal collection. The collection is optionally marked as
read-only.
Parameters:
headers OpenEdge.Messaging.IHeaders
 
readonly LOGICAL
 
Top

Headers (logical)

Purpose:
Construct an empty Headers collection, optionally marking the collection
as read-only.
Parameters:
readonly LOGICAL
 
Top

Headers (RecordHeader[])

Purpose:
Construct a Headers collection and copy of contents of the array
to the internal collection.
Parameters:
headers OpenEdge.Messaging.RecordHeader
 
Top

Headers (RecordHeader[], logical)

Purpose:
Construct a Headers collection and copy the contents of the array
to the internal collection. The collection is optionally marked as
read-only.
Parameters:
headers OpenEdge.Messaging.RecordHeader
 
readonly LOGICAL
 


Property Detail
Top

INTEGER Count

Returns INTEGER
 
Top

LOGICAL IsReadOnly

Returns LOGICAL