Namespace: OpenEdge.Net
Type: Class MultipartEntity
Parent Classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object
Implements: OpenEdge.Net.ISupportMultipartEntity


Copyright (c) 2015, 2018, 2021 by Progress Software Corporation. All rights reserved.
File:MultipartEntity
Purpose:Entity object representing a multi-part entity or message,
per http://www.ietf.org/rfc/rfc2046.txt
Author(s):pjudge
Created:Tue May 19 14:50:22 EDT 2015
Purpose: The character string delimiting the parts. Excludes the leading and trailing --



Method Summary
  Options Name Purpose
  INTEGER AddPart (MessagePart) /** Adds a part to this multi-part entity @param MessagePart The entity for the part @return integer The part number being added. */
  ClearParts () /** Clears all the parts from this multipart entity */
  OpenEdge.Net.MessagePart GetPart (character) /* Returns any parts that have the specified content-id. @param character A content ID to search by @return MessagePart[] An array of parts that have a content ID */
  OpenEdge.Net.MessagePart GetPart (integer) /** Returns a part's content, selected by part number @param integer The part number @return MessagePart The content */
  LOGICAL RemovePart (integer) /** Removes a part (by number) and reorders the parts. @param integer The part number to remove @return logical True if the record was removed */
  LOGICAL SetPart (integer, MessagePart) /** Adds a part to this multi-part entity @param integer The part number being added. @param MessagePart The entity for the part @return logical True if the Part has replaced another part */

Constructor Summary
  Options Name Purpose
  MultipartEntity ()

Property Summary
  Options Name Purpose
  CHARACTER Boundary
  CHARACTER Epilogue
  CHARACTER Prologue
  INTEGER Size


Method Detail
Top

INTEGER AddPart (MessagePart)

Purpose: Adds a part to this multi-part entity
Parameters:
poEntity OpenEdge.Net.MessagePart
 
Returns INTEGER
  integer The part number being added.
Top

ClearParts ()

Purpose: Clears all the parts from this multipart entity
Top

OpenEdge.Net.MessagePart GetPart (character)

/* Returns any parts that have the specified content-id.
Parameters:
pcContentId CHARACTER
 
Returns OpenEdge.Net.MessagePart
  MessagePart[] An array of parts that have a content ID
Top

OpenEdge.Net.MessagePart GetPart (integer)

Purpose: Returns a part's content, selected by part number
Parameters:
piPartNumber INTEGER
 
Returns OpenEdge.Net.MessagePart
  MessagePart The content
Top

LOGICAL RemovePart (integer)

Purpose: Removes a part (by number) and reorders the parts.
Parameters:
piPartNumber INTEGER
 
Returns LOGICAL
  logical True if the record was removed
Top

LOGICAL SetPart (integer, MessagePart)

Purpose: Adds a part to this multi-part entity
Parameters:
piPartNum INTEGER
 
poEntity OpenEdge.Net.MessagePart
 
Returns LOGICAL
  logical True if the Part has replaced another part


Constructor Detail
Top

MultipartEntity ()



Property Detail
Top

CHARACTER Boundary

Returns CHARACTER
 
Top

CHARACTER Epilogue

Returns CHARACTER
 
Top

CHARACTER Prologue

Returns CHARACTER
 
Top

INTEGER Size

Returns INTEGER