Home > Class Reference > ENSLIB namespace > %Library.QueryDefinition

%Library.QueryDefinition

persistent class %Library.QueryDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.QueryDefinition

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package.

This class represents a specific class query description for a class contained within the Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property ClassName as %CacheString;
A string containing the name of the class the query belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Description as %CacheString;
A string containing the description of the query.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property FormalSpec as %CacheString;
A string containing the list of arguments for the query. These are the arguments passed via the Execute() method of the %ResultSet class.
Property methods: FormalSpecGet(), FormalSpecIsValid(), FormalSpecSet()
property Internal as %CacheString;
A flag indicating whether the query is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
property Name as %CacheString;
A string containing the name of the query.
Property methods: NameGet(), NameIsValid(), NameSet()
property Parameters as array of %CacheString;
An array containing any parameter definitions for the query. The array keys are the parameter names and the array values are the parameter values.
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property SQLName as %CacheString;
A string containing the SQL procedure name of the query.
Property methods: SQLNameGet(), SQLNameIsValid(), SQLNameSet()
property SQLProc as %CacheString;
A flag indicating whether the query is projected as an SQL stored procedure (1) or not (0).
Property methods: SQLProcGet(), SQLProcIsValid(), SQLProcSet()
property SQLQuery as %CacheString;
The SQL statements to implement this query.
Property methods: SQLQueryGet(), SQLQueryIsValid(), SQLQuerySet()
property SQLView as %CacheString;
A flag indicating whether the query is projected as an SQL view (1) or not (0).
Property methods: SQLViewGet(), SQLViewIsValid(), SQLViewNameGet(), SQLViewNameIsValid(), SQLViewNameSet(), SQLViewSet()
property SQLViewName as %CacheString;
If the query is projected as an SQL view, this is a string containing the name of the SQL view.
Property methods: SQLViewNameGet(), SQLViewNameIsValid(), SQLViewNameSet()
property SequenceNumber as %CacheString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
Property methods: SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberSet()
property Type as %CacheString;
A string containing the name of the class used for the implementation of the query.
Property methods: TypeGet(), TypeIsValid(), TypeSet()

Methods (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
private method %OnNew(initvalue As %String) as %Status
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.

private method %OnValidateObject() as %Status
Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.

Inherited Members

Inherited Methods (Including Private)