Skip to main content


class %Compiler.Type.Stream extends %Compiler.Type.Object

This is the property class for properties whose type class is a stream.

Method Inventory


parameter CONTENT;
XML element content "MIXED" for mixed="true" and "STRING" or "ESCAPE" for mixed="false". If CONTENT="STRING" (default) XML special characters are put in a CDATA section during XML export. If CONTENT="ESCAPE" XML special characters are escaped during XML export. If CONTENT="ESCAPE-C14N" XML special characters are escaped during XML export using the translate table, XMLC, specified for XML Canonicalizaton. The main difference is that CR is escaped as 
parameter ENCODING = base64;
Encoding to be used for XML serialization of a binary stream.
parameter ESCAPE = XML;
Controls the translate table used to escape content when CONTENT="MIXED" is specified.
parameter LOCATION;
If STORAGE is "GLOBAL", this is the global node reference where the stream data is stored. For file streams this is the directory where the files are stored
parameter MTOM = 1;
If MTOM is true, then the property that references this binary stream is available for optimization when using SOAP MTOM (Message Transmission Optimization Mechanism). The default for binary streams is true.
parameter STORAGE;
This is the storage type of the stream - GLOBAL or OTHER.


classmethod Delete(streamvalue) as %Status
method GetObject(force As %Integer = 0) as %ObjectIdentity
This method obtains the state/id of the referenced object if swizzling has not occurred, it simply returns the stored state else it references the specified object force = an optional parameter, if its value is 1 then if the referenced object is an ID object it must return its ID, which may force it to file itself. No code for this method if the property is a datatype.
method GetSwizzled(noswizzle As %Boolean = 0) as %RegisteredObject
returns an oref, performing swizzling if necessary it returns "" ($$$NULLOREF) if there is no oref and the id="" If noswizzle is passed as true then this will just return the current value for the property, so if it has been swizzled already then it will return the oref, if it has not been swizzled it will return "" ($$$NULLOREF).
method NewObject(type As %RawString = "") as %ObjectHandle
Inherited description: Creates a new object for the referenced property
classmethod Open(streamvalue) as %RegisteredObject
method Set(newvalue As %RawString) as %Status
Inherited description: Set the property to an oref value if the new oref is different from an old oref, the old object is closed
method SetFromShardStream(newvalue As %RawString) as %Status
This method is used when loading an object for a sharded class and getting the stream from the shard-local class We need to perform a type of clone from the stream selected from SQL for the shard-local class and be able to use it in the sharded class

Inherited Members

Inherited Methods

FeedbackOpens in a new tab