Class Definition Reference
Contents
|
|
Preface : | |
| |
Reference A: | |
Class Definitions Describes the structure of a class definition.
Foreign Key Definitions Describes the structure of a foreign key definition.
Index Definitions Describes the structure of an index definition.
Method Definitions Describes the structure of a method definition.
Parameter Definitions Describes the structure of a parameter definition.
Projection Definitions Describes the structure of a projection definition.
Property Definitions Describes the structure of a property definition. Note that a relationship is a property.
Query Definitions Describes the structure of a query definition.
Trigger Definitions Describes the structure of a trigger definition.
XData Blocks Describes the structure of an XData block.
| |
Reference B: | |
Abstract Specifies whether this is an
| |
Reference C: | |
Internal Specifies whether this foreign key definition is internal (not displayed in the class documentation).
NoCheck Specifies whether InterSystems IRIS should check this foreign key constraint.
OnDelete Specifies the action that this foreign key should cause in the current table when a record is deleted in the foreign table.
OnUpdate Specifies the action that this foreign key should cause in the current table when a record is updated in the foreign table.
SqlName Specifies an SQL alias for the foreign key.
| |
Reference D: | |
Condition Defines a conditional index and specifies the condition that must be met for a record to be included in the index.
Data Specifies a list of properties whose values are to be stored within this index.
Extent Defines an extent index.
IdKey Specifies whether this index defines the Object Identity values for the table.
Internal Specifies whether this index definition is internal (not displayed in the class documentation).
PrimaryKey Specifies whether this index defines the primary key for the table.
SqlName Specifies an SQL alias for the index.
Type Specifies the type of index.
Unique Specifies whether the index should enforce uniqueness.
| |
Reference E: | |
Abstract Specifies whether this is an
| |
Reference F: | |
Abstract Specifies whether this is an abstract parameter.
Constraint Specifies a user interface constraint for this parameter.
Deprecated Specifies that this parameter is deprecated. This keyword is ignored by the class compiler and by Studio, but is used by Atelier.
Final Specifies whether this parameter is final (cannot be overridden in subclasses)
Flags Modifies the user interface type (in Studio) for this parameter.
Internal Specifies whether this parameter definition is internal (not displayed in the class documentation).
| |
Reference G: | |
Internal Specifies whether this projection definition is internal (not displayed in the class documentation). Note that the class documentation does not currently display projections at all.
| |
Reference H: | |
Aliases Specifies additional names for this property for use via object access.
Calculated Specifies that this property has no in-memory storage allocated for it when the object containing it is instantiated.
Cardinality Specifies the cardinality of this relationship property. Required for relationship properties. Not used for other properties.
ClientName Specifies an alias used by client projections of this property.
Collection Deprecated means of specifying the collection type of a collection property. Do not use.
Deprecated Specifies that this property is deprecated. This keyword is ignored by the class compiler and by Studio, but is used by Atelier.
Final Specifies whether this property is final (cannot be overridden in subclasses).
Identity Specifies whether this property corresponds to the identity column in the corresponding SQL table. Applies to persistent classes.
InitialExpression Specifies an initial value for this property.
Internal Specifies whether this property definition is internal (not displayed in the class documentation). .
Inverse Specifies the inverse side of this relationship. Required for relationship properties. Not used for other properties.
MultiDimensional Specifies that this property has the characteristics of a multidimensional array.
OnDelete Specifies the action to take in the current table when a related object is deleted. This keyword applies only to a relationship property that specifies
| |
Reference I: | |
ClientName An alias used by client projections of this query.
Final Specifies whether this query is final (cannot be overridden in subclasses).
Internal Specifies whether this query definition is internal (not displayed in the class documentation).
Private Specifies whether the query is private.
SoapBindingStyle Specifies the binding style or SOAP invocation mechanism used by this query, when it is used as a web method. Applies only in a class that is defined as a web service or web client.
SoapBodyUse Specifies the encoding used by the inputs and outputs of this query, when it is used as a web method. Applies only in a class that is defined as a web service or web client.
SoapNameSpace Specifies the namespace at the binding operation level in the WSDL. Applies only in a class that is defined as a web service or web client.
SqlName Overrides the default name of the projected SQL stored procedure. Applies only if this query is projected as an SQL stored procedure.
SqlProc Specifies whether the query can be invoked as an SQL stored procedure.
SqlView Specifies whether to project this query as an SQL view.
SqlViewName Overrides the default name of the projected SQL view. Applies only if this query is projected as an SQL view.
WebMethod Specifies whether this class query is a web method. Applies only in a class that is defined as a web service or web client.
| |
Reference J: | |
CodeMode Specifies how this trigger is implemented.
Event Specifies the SQL events that will fire this trigger. Required (no default).
Final Specifies whether this trigger is final (cannot be overridden in subclasses).
Foreach Controls when the trigger is fired.
Internal Specifies whether this trigger definition is internal (not displayed in the class documentation).
Language Specifies the language in which the trigger is written.
NewTable Specifies the name of the transition table that stores the new values of the row or statement affected by the event.
OldTable Specifies the name of the transition table that stores the old values of the row or statement affected by the event.
Order In the case of multiple triggers for the same EVENT and TIME, specifies the order in which the triggers should be fired.
SqlName Specifies the SQL name to use for this trigger.
Time Specifies whether the trigger is fired before or after the event.
UpdateColumnList Specifies one or more columns whose modification causes the trigger to be fired by SQL. Available only for TSQL.
| |
Reference K: | |
Internal Specifies whether this XData block is internal (not displayed in the class documentation). Note that the class documentation does not currently display XData at all.
MimeType Specifies the MIME type of the XData block.
SchemaSpec Specifies the XML schema against which this XData block can be validated.
XMLNamespace Specifies the XML namespace to which an XData block belongs.
| |
Reference L: | |
DataLocation Specifies where data is stored for this class.
DefaultData Specifies the default data storage definition.
Final Specifies that the storage definition cannot be modified by subclasses.
IdLocation Specifies location of the ID counter.
IndexLocation Specifies the default storage location for indices.
SqlRowIdName Specifies the name used for the row ID within SQL.
SqlRowIdProperty Specifies the SQL RowId property.
SqlTableNumber Specifies the internal SQL table number.
State Specifies the data definition used for a serial object.
StreamLocation Specifies the default storage location for stream properties.
Type Storage class used to provide persistence.
|