Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > %Library.SystemBase
Private  Storage   

%Library.SystemBase


class %Library.SystemBase

Base superclass. For internal use only, this is automatically added to all classes as a superclass.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
18


Summary


Methods
%ClassIsLatestVersion %ClassName %Close %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Extends %GetParameter
%IncrementCount %IsA %New %OriginalNamespace
%PackageName %SetModified

Subclasses
%Exception.CPPException
%Library.Base %Library.DynamicAbstractObject
%SYSTEM.AutoLock
%SYSTEM.Context.DBMSSession %SYSTEM.Context.InterOpFunctions %SYSTEM.Context.SQL
%SYSTEM.Semaphore

Methods


• classmethod %ClassIsLatestVersion() as %Boolean
Return true if this instance is the latest version of this class, and false if the class has been recompiled so there is a newer version on disk
• classmethod %ClassName(fullname As %Boolean) as %String
Returns the object's class name. The fullname determines how the class name is represented. If it is 1 then it returns the full class name including any package qualifier. If it is 0 (the default) then it returns the name of the class without the package, this is mainly for backward compatibility with the pre-package behaviour of %ClassName.
• final method %Close() as %Status
This method is deprecated because we now reference count objects automatically so there is no need to call this method. It is a no-op and just returns success %Status code.
• abstract classmethod %DispatchClassMethod(Class As %String, Method As %String, Args...)
Is used to implement an unknown class method call
• abstract method %DispatchGetModified(Property As %String)
Is used to get the value of the modified flag for an unknown property.
• abstract method %DispatchGetProperty(Property As %String)
Is used to get the value of an unknown property.
• abstract method %DispatchMethod(Method As %String, Args...)
Is used to implement an unknown method call. It is also used to resolve an unknown multidimensional property reference (to get the value of a property) because that syntax is identical to a method call.
• abstract method %DispatchSetModified(Property As %String, Val)
Is used to set the value of the modified flag for an unknown property.
• abstract method %DispatchSetMultidimProperty(Property As %String, Val, Subs...)
Is used to set the value of an unknown multidimensional property.
• abstract method %DispatchSetProperty(Property As %String, Val)
is used to set the value of an unknown property.
• classmethod %Extends(isclass As %String) as %Integer
Returns true (1) if this class is inherited either via primary or secondary inheritance from 'isclass'.
• final classmethod %GetParameter(paramname As %String = "") as %String
This method returns the value of a class parameter at runtime
• final method %IncrementCount() as %Integer
This method is deprecated as reference counting is handled automatically by the system. This is now a no-op and just returns a success code. objects is now handled by the system automatically
• classmethod %IsA(isclass As %String) as %Integer
Returns true (1) if instances of this class are also instances of the isclass parameter. That is 'isclass' is a primary superclass of this object.
• final classmethod %New(initvalue As %RawString) as %ObjectHandle
Creates a new instance of object in memory. %New creates an OREF value that refers to the object instance, registers the OREF with the system along with its class name, and reserves system storage for the properties.

%New initializes all the object's properties to their default values and calls the user-provided method, %OnNew, if it is present. The optional arguments are passed on to the %OnNew method. If the object is persistent, its OID is set to null string (""). %New returns an OREF value that refers to the new object instance or $$$NULLOREF if unable to create the object instance.

• classmethod %OriginalNamespace() as %String
Return the namespace this oref was created in. This also returns the namespace this class was first referenced in if calling class methods.
• final classmethod %PackageName() as %String
Returns the object's package name.
• method %SetModified(value As %Integer) as %Status
Setting the modified state of the object.