Namespace: OpenEdge.Net
Class 
MultipartEntity
Parent classes:
Progress.Lang.Object
OpenEdge.Net.MultipartEntity

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

Copyright (c) 2015 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




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 */

Property Summary
Options Name Purpose
# CHARACTER Boundary /** The character string delimiting the parts. Excludes the leading and trailing -- */
# CHARACTER Epilogue /** Epilogue text to be discarded/ignored. Kept for info purposes */
# CHARACTER Prologue /** Preamble text to be discarded/ignored. Kept for info purposes */
# INTEGER Size /** The number of parts */


Method Detail
Top

PROTECTED 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

PROTECTED ClearParts ()
Purpose: Clears all the parts from this multipart entity
Top

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED 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


Property Detail
Top

PROTECTED CHARACTER Boundary
Purpose: The character string delimiting the parts. Excludes the leading and trailing --
Returns CHARACTER
Top

PROTECTED CHARACTER Epilogue
Purpose: Epilogue text to be discarded/ignored. Kept for info purposes
Returns CHARACTER
Top

PROTECTED CHARACTER Prologue
Purpose: Preamble text to be discarded/ignored. Kept for info purposes
Returns CHARACTER
Top

PROTECTED INTEGER Size
Purpose: The number of parts
Returns INTEGER


10.27.2015 12:36:55