Home > Class Reference > HSLIB namespace > HS.IHE.Common.Messages.MIMEAttachment

HS.IHE.Common.Messages.MIMEAttachment

persistent class HS.IHE.Common.Messages.MIMEAttachment extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_IHE_Common_Messages.MIMEAttachment

Property Inventory

Method Inventory

Parameters

parameter FOUNDATION = 1;
HealthShare Foundation
parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property Body as %CSP.BinaryStream;
Property methods: BodyDelete(), BodyGet(), BodyGetObject(), BodyGetObjectId(), BodyGetStored(), BodyGetSwizzled(), BodyIsValid(), BodyNewObject(), BodyOid(), BodyOpen(), BodySet(), BodySetObject(), BodySetObjectId(), BodyUnSwizzle()
property ContentId as %String);
Property methods: ContentIdDisplayToLogical(), ContentIdGet(), ContentIdGetStored(), ContentIdIsValid(), ContentIdLogicalToDisplay(), ContentIdLogicalToOdbc(), ContentIdNormalize(), ContentIdSet()
property ContentTransferEncoding as %String);
Property methods: ContentTransferEncodingDisplayToLogical(), ContentTransferEncodingGet(), ContentTransferEncodingGetStored(), ContentTransferEncodingIsValid(), ContentTransferEncodingLogicalToDisplay(), ContentTransferEncodingLogicalToOdbc(), ContentTransferEncodingNormalize(), ContentTransferEncodingSet()
property ContentType as %String);
Property methods: ContentTypeDisplayToLogical(), ContentTypeGet(), ContentTypeGetStored(), ContentTypeIsValid(), ContentTypeLogicalToDisplay(), ContentTypeLogicalToOdbc(), ContentTypeNormalize(), ContentTypeSet()
property FilePath as %String);
Optional: path to temporary file instead of storing Body stream This file will be deleted when the persistent object is deleted.
Property methods: FilePathDisplayToLogical(), FilePathGet(), FilePathGetStored(), FilePathIsValid(), FilePathLogicalToDisplay(), FilePathLogicalToOdbc(), FilePathNormalize(), FilePathSet()

Methods

method GetBody() as %CSP.BinaryStream [ Language = objectscript ]
Get the body (either from stream or file)

Throws error if using files and read file fails

classmethod OnDeleteHandler(id) as %Status [ Language = objectscript ]
Deletes temp file on object delete (but will not fail if file cannot be deleted)
method SaveBodyToFile(pBody As %CSP.BinaryStream, pFilePath As %String = "") as %Status [ Language = objectscript ]
Save body to file
pBody
The stream to save
pFilePath
Where to save the file; defaults to temp file

Triggers

trigger OnDeleteSQL (BEFORE event DELETE);

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (HS.IHE.Common.Messages.MIMEAttachment)

^HS.IHE.Comm8F7E.MIMEAttachmentD(ID)
=
%%CLASSNAME
ContentId
ContentType
ContentTransferEncoding
Body
FilePath
FeedbackOpens in a new window