Public Attributes | |
Abstract | |
Specifies that the class cannot have instances; for datatypes, specifies that the class cannot be used as an attribute type. More... | |
Ancestry | |
Ancestry. More... | |
CacheVersion | |
The version of InterSystems IRIS this class was compiled on. More... | |
ClassCompileError | |
Status code from this class compile if there is an error. More... | |
ClassDefinitionError | |
Set to true if there is a problem serializing the class so the compiler knows not to compile this. More... | |
ClassType | |
Specifies how this class is to be used. More... | |
Classes | |
Array of items generated by this class. More... | |
ClientDataType | |
In the case of a datatype class, specifies the type used when exposed via ActiveX or Java. More... | |
ClientDataTypeEnum | |
ClientDataTypeEnum. More... | |
ClientInfo | |
ClientInfo. More... | |
ClientName | |
This gives an alternate name for the class if it projected, for example, to Java. More... | |
CompilationSignature | |
CompilationSignature. More... | |
CompileAfter | |
Indicates that the class compiler should compile this class after the specified classes. More... | |
CompileNamespace | |
The namespace when this class is compiled, used to help dependency checking. More... | |
ConstraintClass | |
Additional constraint member super classes to inherit. More... | |
Constraints | |
Constraint. More... | |
Copyright | |
Optional copyright notice associated with this class. More... | |
DdlAllowed | |
In the case of a persistent class, indicates whether or not DDL statements can be used to alter or delete the class definition. More... | |
DependsOn | |
List of classes that this class depends on being runable in order for this class to compile. More... | |
Deployed | |
Indicates whether the class has been deployed, that is, disassociated from the source that was used to build it. More... | |
Deprecated | |
True if this class is deprecated. More... | |
Description | |
Specifies a description of the class. More... | |
Dynamic | |
Deprecated. More... | |
EmbeddedClass | |
If specified in a member type class is the name of the class which forms the embedded superclass. More... | |
Extents | |
Extents. More... | |
Final | |
Specifies that the class cannot have subclasses. More... | |
ForeignKeys | |
ForeignKey. More... | |
GeneratedBy | |
If this class is generated by some other component then this is the name of the item that generated this class. More... | |
HasCPP | |
True if this class has C++ methods. More... | |
Hash | |
A hash of this class so we can detect when it is changed. More... | |
Hidden | |
Specifies that this class is not typically listed when viewing the contents of the class dictionary. More... | |
Import | |
Supplies a list of class packages to import for this class. More... | |
Importall | |
Importall. More... | |
IncludeCode | |
Specifies an optional list of include files used when compiling this class. More... | |
IncludeCodeAll | |
IncludeCodeAll. More... | |
IncludeGenerator | |
Specifies an optional list of include files used when compiling the method generator methods of this class. More... | |
IncludeMGenAll | |
IncludeMGenAll. More... | |
IndexClass | |
Additional index member super classes to inherit. More... | |
Indices | |
Index. More... | |
Inheritance | |
Define the inheritance order when using multiple inheritance, if a member exists in multiple superclasses which one will take precedence. More... | |
InitialValue | |
If specified the initial serial value for a new object. More... | |
InstanceVars | |
InstanceVar. More... | |
KeywordError | |
KeywordError. More... | |
KeywordModified | |
KeywordModified. More... | |
Language | |
The default language used to implement methods for this class. More... | |
LegacyInstanceContext | |
If true then pass this as first argument of all instance methods. More... | |
Manifest | |
Array of items projected with this class which need to be included in any deployment package we create from this class. More... | |
MemberSuper | |
This is the class to inherit if this class is used as a member class in member inheritance. More... | |
Methods | |
Method. More... | |
ModificationAuxiliary | |
Deprecated. More... | |
ModificationLevel | |
Deprecated. More... | |
Modified | |
If set to 0 then class is always modified, and so it is always saved. More... | |
Name | |
The name of the class. More... | |
NoContext | |
If true, datatype methods have access to the current instance instead of providing their own context. More... | |
NoExtent | |
If TRUE will prevent this class from instantiating a persistent extent. More... | |
OdbcType | |
In the case of a datatype class, specifies the type used when exposed via ODBC or JDBC. More... | |
OldHash | |
Keep track of old hash values so we can modify a class without marking it as out of date. More... | |
Owner | |
Specifies the owner of the class and its corresponding table. More... | |
Parameters | |
Parameter. More... | |
PrimarySuper | |
PrimarySuper. More... | |
ProcedureBlock | |
Specifies that the class uses procedure block for method code. More... | |
Procedures | |
Procedures. More... | |
ProjectionClass | |
Additional projection member super classes to inherit. More... | |
Projections | |
Projection. More... | |
Properties | |
Property. More... | |
PropertyClass | |
Additional property member super classes to inherit. More... | |
Queries | |
Query. More... | |
QueryClass | |
Additional query member super classes to inherit. More... | |
QueryPropInfo | |
Deprecated. More... | |
RandomSig | |
Random value that is updated each time the class is compiled. More... | |
RoutineCount | |
RoutineCount. More... | |
Routines | |
Routines. More... | |
ServerOnly | |
Specifies whether this class is projected to Java clients. More... | |
Sharded | |
0 if table is not sharded, 1 if it is sharded on the shard manager, 2 if it is sharded on the shard itself. More... | |
SlotCount | |
SlotCount. More... | |
SoapBindingStyle | |
Specifies the SOAP Binding used by this class when it is used to send and receive mnessages via SOAP. More... | |
SoapBodyUse | |
Specifies the encoding used for SOAP messages. More... | |
SqlCategory | |
In the case of a datatype class, specifies a type to use for calculations in SQL. More... | |
SqlQualifiedNameQ | |
SqlQualifiedNameQ. More... | |
SqlRoutinePrefix | |
Deprecated. More... | |
SqlRowIdName | |
In the case of a persistent class, specifies an altername field name used for the ID column. More... | |
SqlRowIdPrivate | |
In the case of a persistent class, specifies whether the ID column is projected to ODBC as a hidden field. More... | |
SqlSchemaName | |
SqlSchemaName. More... | |
SqlTableName | |
In the case of a persistent class, specifies the table name used to identify the class in its SQL projection. More... | |
StorageStrategy | |
Specifies the name of the storage strategy used to control persistence for this class. More... | |
Storages | |
Storage. More... | |
Structure | |
Hash of class 'structure' so we can detect when SQL related classes need to be recompiled. More... | |
Super | |
Specifies one or more superclasses for the class. More... | |
System | |
Specifies the order to compile classes in when compiling a set, we always proceed in the order 1,2,3,4,0 where 0 is the default if not specified. More... | |
Tables | |
Tables. More... | |
TimeChanged | |
Gives the time the last change was made to the class. More... | |
TimeCreated | |
Gives the time the class was first created. More... | |
TriggerClass | |
Additional trigger member super classes to inherit. More... | |
Triggers | |
Trigger. More... | |
UDLTexts | |
UDLText. More... | |
ViewQuery | |
Gives the SQL query used for View definition of this class. More... | |
Views | |
Views. More... | |
XDatas | |
XData. More... | |
XMLData | |
XMLData. More... | |
Additional Inherited Members | |
![]() | |
_.Library.Status | AcquireLock (_.Library.String locktype) |
Acquires a lock for the current instance. More... | |
_.Library.Status | LoadData (_.Library.String id) |
LoadData() - loads an object from storage. More... | |
_.Library.Status | OnAfterSave (_.Library.Boolean insert) |
This callback method is invoked by the <METHOD>Save</METHOD> method to. More... | |
_.Library.Status | OnBeforeSave (_.Library.Boolean insert) |
This callback method is invoked by the <METHOD>Save</METHOD> method to. More... | |
_.Library.Status | OnOpen () |
This callback method is invoked by the <METHOD>Open</METHOD> method to. More... | |
_.Library.Status | OnReload () |
This callback method is invoked by the <METHOD>Reload</METHOD> method to. More... | |
_.Library.Status | OnRollBack () |
This callback method is invoked by the <METHOD>Save</METHOD> method to. More... | |
_.Library.Status | ReleaseLock (_.Library.String locktype) |
Releases a lock for the current instance. More... | |
_.Library.Status | SaveData (_.Library.String id) |
SaveData() - saves an object to disk, checks uniqueness and referential More... | |
![]() | |
_.Library.Status | OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter) |
This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More... | |
![]() | |
_.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
This callback method is invoked when the current object is added to the SaveSet,. More... | |
_.Library.Status | OnClose () |
This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
_.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
_.Library.Status | OnNew () |
This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
_.Library.Status | OnValidateObject () |
This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
![]() | |
_.Library.Status | DeleteData (_.Library.String id, _.Library.Integer concurrency) |
This method is normally generated by the storage class for persistent classes using. More... | |
_.Library.Status | KillExtentData (_.Library.Boolean killstreams) |
KillExtentData() - kills extent data in storage. More... | |
_.Library.Status | OnAfterBuildIndices (_.Library.String indexlist) |
This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More... | |
_.Library.Status | OnAfterDelete (_.Library.ObjectIdentity oid) |
This callback method is invoked by the <METHOD>Delete</METHOD> method to. More... | |
_.Library.Status | OnAfterPurgeIndices (_.Library.String indexlist) |
This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More... | |
_.Library.Status | OnBeforeBuildIndices (_.Library.String indexlist) |
_.Library.Status | OnBeforePurgeIndices (_.Library.String indexlist) |
_.Library.Status | OnDelete (_.Library.ObjectIdentity oid) |
This callback method is invoked by the <METHOD>Delete</METHOD> method to. More... | |
![]() | |
XCOMPACTANCESTRY | |
XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More... | |
DATALOCATIONGLOBAL = None | |
Global name containing master map data for this class. More... | |
DEFAULTGLOBAL = None | |
DSCONDITION = None | |
DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More... | |
DSINTERVAL = None | |
DSINTERVAL is the number of seconds between one DSTIME value and the next. More... | |
DSTIME = None | |
If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More... | |
EXTENTQUERYSPEC = None | |
The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More... | |
EXTENTSIZE = None | |
The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More... | |
GUIDENABLED = None | |
If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More... | |
IDENTIFIEDBY = None | |
The IDENTIFIEDBY parameter can optionally be set to the name. More... | |
MANAGEDEXTENT = None | |
The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More... | |
READONLY = None | |
READONLY = 1 means that objects can be created, opened but not saved or deleted. More... | |
ROWLEVELSECURITY = None | |
ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More... | |
SQLPREVENTFULLSCAN = None | |
SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More... | |
STORAGEDEFAULT = None | |
STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More... | |
USEEXTENTSET = None | |
VERSIONCLIENTNAME = None | |
VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More... | |
VERSIONPROPERTY = None | |
VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More... | |
![]() | |
DEFAULTCONCURRENCY = None | |
DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More... | |
JOURNALSTREAM = None | |
If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More... | |
OBJJOURNAL = None | |
if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More... | |
![]() | |
CAPTION = None | |
Optional name used by the Form Wizard for a class when generating forms. More... | |
JAVATYPE = None | |
The Java type to be used when exported. | |
PROPERTYVALIDATION = None | |
This parameter controls the default validation behavior for the object. More... | |
Abstract |
Specifies that the class cannot have instances; for datatypes, specifies that the class cannot be used as an attribute type.
Ancestry |
Ancestry.
CacheVersion |
The version of InterSystems IRIS this class was compiled on.
ClassCompileError |
Status code from this class compile if there is an error.
ClassDefinitionError |
Set to true if there is a problem serializing the class so the compiler knows not to compile this.
ClassType |
Specifies how this class is to be used.
Classes |
Array of items generated by this class.
ClientDataType |
In the case of a datatype class, specifies the type used when exposed via ActiveX or Java.
Datatype classes must specify a client datatype.
ClientDataTypeEnum |
ClientDataTypeEnum.
ClientInfo |
ClientInfo.
ClientName |
This gives an alternate name for the class if it projected, for example, to Java.
CompilationSignature |
CompilationSignature.
CompileAfter |
Indicates that the class compiler should compile this class after the specified classes.
CompileNamespace |
The namespace when this class is compiled, used to help dependency checking.
ConstraintClass |
Additional constraint member super classes to inherit.
Constraints |
Constraint.
Copyright |
Optional copyright notice associated with this class.
DdlAllowed |
In the case of a persistent class, indicates whether or not DDL statements can be used to alter or delete the class definition.
DependsOn |
List of classes that this class depends on being runable in order for this class to compile.
Deployed |
Indicates whether the class has been deployed, that is, disassociated from the source that was used to build it.
Deprecated |
True if this class is deprecated.
Description |
Specifies a description of the class.
Dynamic |
Deprecated.
EmbeddedClass |
If specified in a member type class is the name of the class which forms the embedded superclass.
Extents |
Extents.
Final |
Specifies that the class cannot have subclasses.
ForeignKeys |
ForeignKey.
GeneratedBy |
If this class is generated by some other component then this is the name of the item that generated this class.
HasCPP |
True if this class has C++ methods.
Hash |
A hash of this class so we can detect when it is changed.
Hidden |
Specifies that this class is not typically listed when viewing the contents of the class dictionary.
Import |
Supplies a list of class packages to import for this class.
Importall |
Importall.
IncludeCode |
Specifies an optional list of include files used when compiling this class.
IncludeCodeAll |
IncludeCodeAll.
IncludeGenerator |
Specifies an optional list of include files used when compiling the method generator methods of this class.
IncludeMGenAll |
IncludeMGenAll.
IndexClass |
Additional index member super classes to inherit.
Indices |
Index.
Inheritance |
Define the inheritance order when using multiple inheritance, if a member exists in multiple superclasses which one will take precedence.
InitialValue |
If specified the initial serial value for a new object.
InstanceVars |
InstanceVar.
KeywordError |
KeywordError.
KeywordModified |
KeywordModified.
Language |
The default language used to implement methods for this class.
LegacyInstanceContext |
If true then pass this as first argument of all instance methods.
Manifest |
Array of items projected with this class which need to be included in any deployment package we create from this class.
MemberSuper |
This is the class to inherit if this class is used as a member class in member inheritance.
Methods |
Method.
ModificationAuxiliary |
Deprecated.
ModificationLevel |
Deprecated.
Modified |
If set to 0 then class is always modified, and so it is always saved.
Name |
The name of the class.
NoContext |
If true, datatype methods have access to the current instance instead of providing their own context.
NoExtent |
If TRUE will prevent this class from instantiating a persistent extent.
OdbcType |
In the case of a datatype class, specifies the type used when exposed via ODBC or JDBC.
Datatype classes must specify an ODBC type.
OldHash |
Keep track of old hash values so we can modify a class without marking it as out of date.
Owner |
Specifies the owner of the class and its corresponding table.
By default, classes and tables are owned by _SYSTEM.
Parameters |
Parameter.
PrimarySuper |
PrimarySuper.
ProcedureBlock |
Specifies that the class uses procedure block for method code.
Procedures |
Procedures.
ProjectionClass |
Additional projection member super classes to inherit.
Projections |
Properties |
Property.
PropertyClass |
Additional property member super classes to inherit.
Queries |
Query.
QueryClass |
Additional query member super classes to inherit.
QueryPropInfo |
Deprecated.
RandomSig |
Random value that is updated each time the class is compiled.
RoutineCount |
RoutineCount.
Routines |
Routines.
ServerOnly |
Specifies whether this class is projected to Java clients.
Sharded |
0 if table is not sharded, 1 if it is sharded on the shard manager, 2 if it is sharded on the shard itself.
SlotCount |
SlotCount.
SoapBindingStyle |
SoapBodyUse |
Specifies the encoding used for SOAP messages.
SqlCategory |
SqlQualifiedNameQ |
SqlQualifiedNameQ.
SqlRoutinePrefix |
Deprecated.
SqlRowIdName |
In the case of a persistent class, specifies an altername field name used for the ID column.
By default the ID is called ID.
SqlRowIdPrivate |
In the case of a persistent class, specifies whether the ID column is projected to ODBC as a hidden field.
SqlSchemaName |
SqlSchemaName.
SqlTableName |
StorageStrategy |
Specifies the name of the storage strategy used to control persistence for this class.
Storages |
Structure |
Hash of class 'structure' so we can detect when SQL related classes need to be recompiled.
Super |
Specifies one or more superclasses for the class.
System |
Specifies the order to compile classes in when compiling a set, we always proceed in the order 1,2,3,4,0 where 0 is the default if not specified.
Tables |
Tables.
TimeChanged |
Gives the time the last change was made to the class.
TimeCreated |
Gives the time the class was first created.
TriggerClass |
Additional trigger member super classes to inherit.
Triggers |
Trigger.
UDLTexts |
UDLText.
ViewQuery |
Gives the SQL query used for View definition of this class.
Views |
Views.
XDatas |
XData.
XMLData |
XMLData.