Home > Class Reference > HSLIB namespace > Ens.Util.XML.Entity

Ens.Util.XML.Entity

persistent class Ens.Util.XML.Entity extends %Library.Persistent

SQL Table Name: Ens_Util_XML.Entity

Property Inventory

Method Inventory

Properties

property EntityKey as %String [ Required ];
This property holds the key by which the entity is known
Property methods: EntityKeyDisplayToLogical(), EntityKeyGet(), EntityKeyGetStored(), EntityKeyIsValid(), EntityKeyLogicalToDisplay(), EntityKeyLogicalToOdbc(), EntityKeyNormalize(), EntityKeySet()
property Stream as %GlobalBinaryStream;
This property holds the external schema/dtd definition
Property methods: StreamDelete(), StreamGet(), StreamGetObject(), StreamGetObjectId(), StreamGetStored(), StreamGetSwizzled(), StreamIsValid(), StreamNewObject(), StreamOid(), StreamOpen(), StreamSet(), StreamSetObject(), StreamSetObjectId(), StreamUnSwizzle()

Methods

method %OnNew(pInit) 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.

classmethod LoadEntity(pID As %String, Output pEntity As Ens.Util.XML.Entity) as %Status [ Language = objectscript ]
Load an entity instance given it's key
classmethod StoreEntity(pFileName As %String, pKey As %String) as %Status [ Language = objectscript ]

Indexes

index (Primary on EntityKey) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PrimaryCheck(), PrimaryDelete(), PrimaryExists(), PrimaryOpen(), PrimarySQLCheckUnique(), PrimarySQLExists(), PrimarySQLFindPKeyByConstraint(), PrimarySQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (Ens.Util.XML.Entity)

^Ens.Util.EntityD(ID)
=
%%CLASSNAME
EKey
Stream
EntityKey
FeedbackOpens in a new window