Contents
Preface : 
Class Definition Reference
 
 
Reference A: 
Class Keywords
 
  • Abstract — Specifies that this is an abstract class.
  • ClassType — Specifies the type (or behavior) of a class.
  • ClientDataType — In the case of a data type class, specifies the client data type used when this datatype is projected via ActiveX or Java.
  • ClientName — An alias used client projections of this class.
  • CompileAfter — Indicates that the class compiler should compile this class after the specified classes.
  • DdlAllowed — In the case of a persistent class, indicates whether or not DDL statements can be used to alter or delete the class definition.
  • Description — Specifies a description of the class.
  • Dynamic — Dynamic
  • Final — Specifies that the class cannot have subclasses.
  • Hidden — Specifies that this class is not typically listed when viewing the contents of the class dictionary.
  • Import — Specifies one or more class packages to import for this class.
  • IncludeCode — Specifies an optional list of Caché include (.INC) files used when compiling this class.
  • IncludeGenerator — Specifies an optional list of Caché include (.INC) files used when compiling this class' method generator methods.
  • Language — The default language used to implement methods for this class.
  • Modified — Deprecated. Specifies how instances of this class monitor how attributes of the class have changed since the last save.
  • Name (Class) — The name of the class.
  • OdbcType — In the case of a data type class, specifies the type used when exposed via ODBC or JDBC. Data type classes must specify an ODBC type.
  • Owner — Specifies the owner of the class and its corresponding table.
  • ProcedureBlock — Specifies that the class uses Caché ObjectScript procedure blocks for method code
  • PropertyClass — PropertyClass
  • SoapBindingStyle — Specifies the SOAP Binding used by this class when used used with SOAP.
  • SoapBodyUse — Specifies the encoding used by this class when used used with SOAP.
  • SqlCategory — In the case of a data type class, specifies a type to use for calculations in SQL.
  • SqlRoutinePrefix — Deprecated. SqlRoutinePrefix
  • SqlRowIdName — Specifies an alternate SQL field name for the ID column.
  • SqlRowIdPrivate — Specifies whether the ID column is projected to ODBC / JDBC as a hidden field.
  • SqlTableName — Specifies the table name used to identify the class in its SQL projection.
  • StorageStrategy — Name of the Storage definition used to control persistence for this class.
  • Super — Specifies one or more superclasses for the class.
  • System — Specifies that the class is internal to the implementation of Caché. This is not for use within customer applications.
  • ViewQuery — SQL Query for a View Definition class.
    •
    Reference B: 
    ForeignKey Keywords
     
  • Description — Description
  • Name (Foreign Key) — Name
  • OnDelete — Specifies OnDelete referential action.
  • OnUpdate — Specifies OnUpdate referential action.
  • Properties — Specifies properties constrained by the foreign key.
  • ReferencedClass — Specify the class referenced by a foreign key.
  • ReferencedKey — Specify the key referenced by a foreign key.
  • SqlName — Specify an SQL alias for the foreign key.
    •
    Reference C: 
    Index Keywords
     
  • Condition — In the case of a conditional index, specifies the condition that must be met for an entry to be included in the index.
  • Data — Specifies a list of properties whose values are to be stored within this index.
  • Description — Specifies a description of the index.
  • Extent — Define an Extent index
  • Final — Specifies that the index is final.
  • IdKey — Specifies an index to be used as the Object ID
  • Name (Index) — The name of the index.
  • PrimaryKey — Specifies a Primary Key.
  • Properties — Specifies a list of properties used to build this index. May also include a collation specification for each property.
  • SqlName — Specify an SQL alias for the index.
  • Type — Specifies the type of the index.
  • Unique — Specifies a unique index.
    •
    Reference D: 
    Method Keywords
     
  • Abstract — Specifies that this is an abstract method.
  • ClassMethod — Specifies that the method is a class method.
  • CodeMode — Specifies how a method is implemented.
  • Description — Specifies a description of the method.
  • Final — Specifies that the method is final.
  • FormalSpec — Specifies the list of arguments that are passed to the method when it is invoked.
  • GenerateAfter — In the case of a method generator method, specifies that the generator should be invoked after the listed methods are generated.
  • Implementation — The code that is executed when the method is invoked. In the case of an expression method, this is an expression. In the case of a call method, this is the name of a Caché routine to call.
  • Language — The language used to implement this method.
  • Name (Method) — The name of the method.
  • NotForProperty — Indicates that a method of a datatype class is not used to generate a property method.
  • NotInheritable — NotInheritable
  • PlaceAfter — Specifies that the class compiler should place this method after the listed methods in the routine it creates for the class.
  • Private — Specifies that the method is private. Private methods can only be invoked by instance methods of this class (or its subclasses).
  • ProcedureBlock — Specifies that a Caché ObjectScript method will use procedure blocks.
  • PublicList — Specifies the public list for a Caché ObjectScript method.
  • ReturnType — Specifies the data type of the value returned by a call to the method.
  • ServerOnly — Specifies that a method will not be projected to a Java or C++ client.
  • SoapBindingStyle — Specifies which SOAP invocation mechanism a Web Method will use.
  • SoapBodyUse — Specifies which SOAP encoding the inputs and outputs of a Web Method will use.
  • SqlName — If this method is projected as an SQL stored procedure, then this name is used as the name of the stored procedure
  • SqlProc — Specifies that the method can be invoked as an SQL stored procedure. Only class methods can be called as SQL stored procedures.
  • WebMethod — Specifies that this is a Web Method.
    •
    Reference E: 
    Parameter Keywords
     
  • Constraint — Specifies a User Interface constraint for the parameter.
  • Default — Specifies a default value for the parameter.
  • Description — Specifies a description of the parameter.
  • Final — Specifies that subclasses cannot override the definition of the parameter.
  • Flags — Modifies the User Interface type for this parameter.
  • Name (Parameter) — The name of the parameter.
  • Type — Specifies a User Interface type for the parameter.
    •
    Reference F: 
    Property Keywords
     
  • Calculated — Specifies that the property has no in-memory storage allocated for it when the object containing it is instantiated.
  • Cardinality — Specifies the cardinality of a relationship property.
  • Collection — Specifies the collection type of a collection property.
  • Description — Specifies a description of the property.
  • Final — Specifies that subclasses cannot override the definition of this property.
  • InitialExpression — Specifies an initial value for the property.
  • Inverse — Specifies the inverse side of a relationship.
  • MultiDimensional — Specifies that a property has the characteristics of a multidimensional array.
  • Name (Property) — The name of the property.
  • NotInheritable — NotInheritable
  • Private — Specifies that the property is private. Private properties can only be used by instance methods of this class (or its subclasses).
  • Relationship — Specifies that a property is a relationship property.
  • Required — In the case of a persistent class, specifies that the property's value must be given a value before it can be stored to disk.
  • SqlCollation — SqlCollation (deprecated)
  • SqlColumnNumber — Set the SQL Column Number for this property.
  • SqlComputeCode — Specify code that computes a computed field value.
  • SqlComputeOnChange — Specify fields this field calculation depends upon.
  • SqlComputed — Specifies a computed field.
  • SqlFieldName — In the case of a persistent class, specifies the column name used to identify the property in its SQL projection. By default, the SQL column name is the same as the property name.
  • SqlListDelimiter — Specifies the delimiter character used within SQL for lists.
  • SqlListType — SqlListType
  • Transient — In the case of a persistent class, specifies that the property is not stored in the database.
  • Type — Specifies the name of the class associated with the property, which can be a data type class, a persistent class, or an embeddable (serial) class.
    •
    Reference G: 
    Query Keywords
     
  • Description — Specifies a description of the query.
  • Final — Specifies that subclasses cannot override the definition of the query.
  • FormalSpec — Specifies the list of arguments that are passed to the query.
  • Name — The name of the query.
  • NotInheritable — NotInheritable
  • Private — Specifies that the query is private.
  • SqlName — If this query is projected as an SQL stored procedure, then this name is used as the name of the stored procedure
  • SqlProc — Specifies that the query can be invoked as an SQL stored procedure.
  • SqlQuery — Specify an SQL Statement for an SQL-based query.
  • SqlView — Project this query as an SQL View.
  • SqlViewName — Provide an SQL alias for the view projected from this query.
  • Type — Specifies the Query class used to provide the implementation of the query interface.
    •
    Reference H: 
    Trigger Keywords
     
  • Code — The code that is executed when the trigger is fired.
  • Description — Specifies a description of the SQL trigger.
  • Event — Specifies the SQL event that will fire the trigger.
  • Final — Specifies that subclasses cannot override the definition of the SQL trigger.
  • Name (Trigger) — The name of the SQL trigger.
  • Order — In the case of multiple triggers for the same EVENT and TIME, specifies the order in which the triggers should be fired.
  • SqlName — SqlName
  • Time — Specifies whether the trigger is fired before or after the EVENT.
    •
    Reference I: 
    Storage Keywords
     
  • DataLocation — Specify where data is stored for this class.
  • DefaultData — Specifies the Default Data Storage Definition
  • Description — Description
  • Final — Specifies that the storage definition cannot be modified by subclasses.
  • IdExpression — IdExpression
  • IdLocation — Specifies location of the ID Counter.
  • IndexLocation — Specifies the default storage location for indices.
  • Name (Storage) — Name
  • SqlChildSub — SqlChildSub
  • SqlIdExpression — SqlIdExpression
  • SqlRowIdName — Specify 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.
    •
    Reference J: 
    StorageData Keywords
     
  • Attribute — Attribute
  • Name (Storage Data) — Name
  • Structure — Structure
  • Subscript — Subscript
    •
    Reference K: 
    StorageDataValue Keywords
     
  • Name (StorageDataValue) — Name
  • Value — Value
    •
    Reference L: 
    StorageIndex Keywords
     
  • Location — Location
  • Name (StorageIndex) — Name
    •
    Reference M: 
    StorageSqlmap Keywords
     
  • Condition — Condition
  • ConditionFields — ConditionFields
  • ConditionalWithHostVars — ConditionalWithHostVars
  • Global — Global
  • Name (StorageSqlMap) — Name
  • PopulationPct — PopulationPct
  • PopulationType — PopulationType
  • RowReference — RowReference
  • Structure — Structure
  • Type — Type
    •
    Reference N: 
    StorageSqlmapData Keywords
     
  • Delimiter — Delimiter
  • Name (StorageSqlMapData) — Name
  • Node — Node
  • Piece — Piece
  • RetrievalCode — RetrievalCode
    •
    Reference O: 
    StorageSqlmapRowidspec Keywords
     
  • Expression — Expression
  • Field — Field
  • Name (StorageSqlMapRowIdSpec) — Name
    •
    Reference P: 
    StorageSqlmapSubscript Keywords
     
  • AccessType — AccessType
  • DataAccess — DataAccess
  • Delimiter — Delimiter
  • Expression — Expression
  • LoopInitValue — LoopInitValue
  • Name (StorageSqlMapSubscript) — Name
  • NextCode — NextCode
  • NullMarker — NullMarker
  • StartValue — StartValue
  • StopExpression — StopExpression
  • StopValue — StopValue
    •
    Reference Q: 
    StorageSqlmapSubscriptAccessvar Keywords
     
  • Code — Code
  • Name (StorageSqlMapSubscriptAccessVar) — Name
  • Variable — Variable
    •
    Reference R: 
    StorageSqlmapSubscriptInvalidcondition Keywords
     
  • Expression — Expression
  • Name (StorageSqlMapSubscriptInvalidCondition) — Name
    •
    Copyright  © 1997-2006, InterSystems Corp. Last updated: 2005-09-16 11:55:51 Source: ROBJ.xml