Home > Class Reference > ENSLIB namespace > Ens.StreamContainer

Ens.StreamContainer

persistent class Ens.StreamContainer extends %Library.Persistent, Ens.Util.MessageBodyMethods, %XML.Adaptor

SQL Table Name: Ens.StreamContainer

This class is a persistent object that transparently encapsulates any type of persistable stream object

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Attributes as array of %String);
An array of strings containing any attribute values
Property methods: AttributesBuildValueArray(), AttributesCollectionToDisplay(), AttributesCollectionToOdbc(), AttributesDisplayToCollection(), AttributesDisplayToLogical(), AttributesGet(), AttributesGetObject(), AttributesGetObjectId(), AttributesGetStored(), AttributesGetSwizzled(), AttributesIsValid(), AttributesLogicalToDisplay(), AttributesLogicalToOdbc(), AttributesNormalize(), AttributesOdbcToCollection(), AttributesSet(), AttributesSetObject(), AttributesSetObjectId()
property OriginalFilename as %String);
Property methods: OriginalFilenameDisplayToLogical(), OriginalFilenameGet(), OriginalFilenameGetStored(), OriginalFilenameIsValid(), OriginalFilenameLogicalToDisplay(), OriginalFilenameLogicalToOdbc(), OriginalFilenameNormalize(), OriginalFilenameSet()
property OutputFilename as %String);
This property can be used to store a filename to be used on output
Used for example in the EnsLib.MFT.Operation.Passthrough
Property methods: OutputFilenameDisplayToLogical(), OutputFilenameGet(), OutputFilenameGetStored(), OutputFilenameIsValid(), OutputFilenameLogicalToDisplay(), OutputFilenameLogicalToOdbc(), OutputFilenameNormalize(), OutputFilenameSet()
property OutputFolder as %String);
This property can be used to store a folder identifier to be used on output.
Used for example in the EnsLib.MFT.Operation.Passthrough
Property methods: OutputFolderDisplayToLogical(), OutputFolderGet(), OutputFolderGetStored(), OutputFolderIsValid(), OutputFolderLogicalToDisplay(), OutputFolderLogicalToOdbc(), OutputFolderNormalize(), OutputFolderSet()
property Stream as %Stream.Object [ Calculated , Transient ];
Property methods: StreamBFDelete(), StreamBFGet(), StreamBFGetObject(), StreamBFGetObjectId(), StreamBFGetStored(), StreamBFGetSwizzled(), StreamBFIsValid(), StreamBFNewObject(), StreamBFOid(), StreamBFOpen(), StreamBFSetObject(), StreamBFSetObjectId(), StreamBFUnSwizzle(), StreamBGDelete(), StreamBGGet(), StreamBGGetObject(), StreamBGGetObjectId(), StreamBGGetStored(), StreamBGGetSwizzled(), StreamBGIsValid(), StreamBGNewObject(), StreamBGOid(), StreamBGOpen(), StreamBGSetObject(), StreamBGSetObjectId(), StreamBGUnSwizzle(), StreamCFDelete(), StreamCFGet(), StreamCFGetObject(), StreamCFGetObjectId(), StreamCFGetStored(), StreamCFGetSwizzled(), StreamCFIsValid(), StreamCFNewObject(), StreamCFOid(), StreamCFOpen(), StreamCFSetObject(), StreamCFSetObjectId(), StreamCFUnSwizzle(), StreamCGDelete(), StreamCGGet(), StreamCGGetObject(), StreamCGGetObjectId(), StreamCGGetStored(), StreamCGGetSwizzled(), StreamCGIsValid(), StreamCGNewObject(), StreamCGOid(), StreamCGOpen(), StreamCGSetObject(), StreamCGSetObjectId(), StreamCGUnSwizzle(), StreamDelete(), StreamFBDelete(), StreamFBGet(), StreamFBGetObject(), StreamFBGetObjectId(), StreamFBGetStored(), StreamFBGetSwizzled(), StreamFBIsValid(), StreamFBNewObject(), StreamFBOid(), StreamFBOpen(), StreamFBSetObject(), StreamFBSetObjectId(), StreamFBUnSwizzle(), StreamFCDelete(), StreamFCGet(), StreamFCGetObject(), StreamFCGetObjectId(), StreamFCGetStored(), StreamFCGetSwizzled(), StreamFCIsValid(), StreamFCNewObject(), StreamFCOid(), StreamFCOpen(), StreamFCSetObject(), StreamFCSetObjectId(), StreamFCUnSwizzle(), StreamGBDelete(), StreamGBGet(), StreamGBGetObject(), StreamGBGetObjectId(), StreamGBGetStored(), StreamGBGetSwizzled(), StreamGBIsValid(), StreamGBNewObject(), StreamGBOid(), StreamGBOpen(), StreamGBSetObject(), StreamGBSetObjectId(), StreamGBUnSwizzle(), StreamGCDelete(), StreamGCGet(), StreamGCGetObject(), StreamGCGetObjectId(), StreamGCGetStored(), StreamGCGetSwizzled(), StreamGCIsValid(), StreamGCNewObject(), StreamGCOid(), StreamGCOpen(), StreamGCSetObject(), StreamGCSetObjectId(), StreamGCUnSwizzle(), StreamGet(), StreamSet()
property Type as %String (MAXLEN = 2) [ ReadOnly ];
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize()

Methods (Including Private)

private classmethod %OnDelete(oid As %ObjectIdentity) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted.

private method %OnNew(pInput As %RawString = $$$NULLOREF, pAttributes As %Collection.ArrayOfDT = $$$NULLOREF) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %OnOpen() as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Open() method to provide notification that the object specified by oid is being opened.

If this method returns an error then the object will not be opened.

method SetAttributes(ByRef pAttributes) [ Language = objectscript ]
Set values into the Attributes array property Pass in an array object, a ObjectScript array, a ObjectScript array reference, a %AbstractStream with its own Attributes to copy from, a %Net.HttpResponse object with its own Headers to copy from, or a string of the form 'a=1,b=2,c=3'.
method StreamGet() as %Stream.Object [ Language = objectscript ]
method StreamSet(pInput As %Stream.Object) as %Status [ Language = objectscript ]

Triggers

trigger OnDelete (BEFORE event DELETE);

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: Storage (Ens.StreamContainer)

^Ens.StreamContainerD(ID,"Attributes",n)
=
Attributes(n)

Storage Model: Storage (Ens.StreamContainer)

^Ens.StreamContainerD(ID)
=
%%CLASSNAME
OriginalFilename
StreamFB
StreamFC
StreamGB
StreamGC
Type
StreamCF
StreamBF
StreamCG
StreamBG
FileCharEncodingTable
CharEncodingTable
OutputFolder
OutputFilename

Subclasses

FeedbackOpens in a new window