Skip to main content


persistent class %Dictionary.QueryDefinition extends %Library.Persistent, %Dictionary.QueryDefinitionQuery

SQL Table Name: %Dictionary.QueryDefinition

Property Inventory

Method Inventory


parameter SQLENABLED = 1;


property ClientName as %RawString;
An alias used by client projections of this query.
Property methods: ClientNameGet(), ClientNameIsValid()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this query is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize()
property Description as %RawString;
Specifies a description of the query.
Property methods: DescriptionGet(), DescriptionIsValid()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the query.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize()
property FormalSpec as %RawString;
Specifies the list of arguments passed to the Execute method. Each argument is of the format [&|*]<name>[:<type>][=<default>] where & means pass-by-reference and * means output-only.
Property methods: FormalSpecGet(), FormalSpecIsValid()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize()
property Name as %Dictionary.Identifier [ Required ];
The name of the query.
Property methods: NameGet(), NameIsValid()
property NotInheritable as %Boolean [ InitialExpression = 0 ];
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize()
property Parameters as array of %RawString;
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Private as %Boolean [ InitialExpression = 0 ];
Property methods: PrivateDisplayToLogical(), PrivateGet(), PrivateIsValid(), PrivateLogicalToDisplay(), PrivateNormalize()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize()
property SoapBindingStyle as %RawString;
Specifies what type of SOAP invocation is used for a web method. This keyword is ignored for non-web methods.
Property methods: SoapBindingStyleGet()
property SoapBodyUse as %RawString;
Specifies what kind of SOAP encoding is used for the inputs and outputs of a web method. This keyword is ignored for non-web methods.
Property methods: SoapBodyUseGet()
property SoapNameSpace as %RawString;
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.
Property methods: SoapNameSpaceGet(), SoapNameSpaceIsValid()
property SqlName as %RawString;
If this query is projected as an SQL stored procedure, then this name is used as the name of the stored procedure.
Property methods: SqlNameGet(), SqlNameIsValid()
property SqlProc as %Boolean [ InitialExpression = 0 ];
Specifies that the query can be invoked as an SQL stored procedure.
Property methods: SqlProcDisplayToLogical(), SqlProcGet(), SqlProcIsValid(), SqlProcLogicalToDisplay(), SqlProcNormalize()
property SqlQuery as %RawString;
Specifies an SQL statement to be used for an SQL-based query.
Property methods: SqlQueryGet(), SqlQueryIsValid()
property SqlView as %Boolean [ InitialExpression = 0 ];
Specifies whether to project this query as an SQL View.
Property methods: SqlViewDisplayToLogical(), SqlViewGet(), SqlViewIsValid(), SqlViewLogicalToDisplay(), SqlViewNormalize()
property SqlViewName as %RawString;
Specifies an SQL alias for the view projected from this query.
Property methods: SqlViewNameGet(), SqlViewNameIsValid()
property Type as %Dictionary.Classname;
Specifies the Query class used to provide the implementation of the query interface.
Property methods: TypeGet(), TypeIsValid()
property WebMethod as %Boolean [ InitialExpression = 0 ];
description=Specifies that this query can be invoked using the SOAP protocol.
Property methods: WebMethodDisplayToLogical(), WebMethodGet(), WebMethodIsValid(), WebMethodLogicalToDisplay(), WebMethodNormalize()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = Queries , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()


classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Inherited description: Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
Inherited description: Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
method ClientNameIsDefined() as %Boolean
method ClientNameReset()
method ClientNameSet(value As %String = "") as %Status
method DeprecatedIsDefined() as %Boolean
method DeprecatedReset()
method DeprecatedSet(value As %String = "") as %Status
method DescriptionIsDefined() as %Boolean
method DescriptionReset()
method DescriptionSet(value As %String = "") as %Status
method FinalIsDefined() as %Boolean
method FinalReset()
method FinalSet(value As %String = "") as %Status
method FormalSpecIsDefined() as %Boolean
method FormalSpecReset()
method FormalSpecSet(value As %String = "") as %Status
method InternalIsDefined() as %Boolean
method InternalReset()
method InternalSet(value As %String = "") as %Status
method NameIsDefined() as %Boolean
method NameReset()
method NameSet(value As %String = "") as %Status
method NotInheritableIsDefined() as %Boolean
method NotInheritableReset()
method NotInheritableSet(value As %String = "") as %Status
method PrivateIsDefined() as %Boolean
method PrivateReset()
method PrivateSet(value As %String = "") as %Status
method SequenceNumberIsDefined() as %Boolean
method SequenceNumberReset()
method SequenceNumberSet(value As %String = "") as %Status
method SoapBindingStyleIsDefined() as %Boolean
classmethod SoapBindingStyleIsValid(val As %String) as %Status
method SoapBindingStyleReset()
method SoapBindingStyleSet(value As %String = "") as %Status
method SoapBodyUseIsDefined() as %Boolean
classmethod SoapBodyUseIsValid(val As %String) as %Status
method SoapBodyUseReset()
method SoapBodyUseSet(value As %String = "") as %Status
method SoapNameSpaceIsDefined() as %Boolean
method SoapNameSpaceReset()
method SoapNameSpaceSet(value As %String = "") as %Status
method SqlNameIsDefined() as %Boolean
method SqlNameReset()
method SqlNameSet(value As %String = "") as %Status
method SqlProcIsDefined() as %Boolean
method SqlProcReset()
method SqlProcSet(value As %String = "") as %Status
method SqlQueryIsDefined() as %Boolean
method SqlQueryReset()
method SqlQuerySet(value As %String = "") as %Status
method SqlViewIsDefined() as %Boolean
method SqlViewNameIsDefined() as %Boolean
method SqlViewNameReset()
method SqlViewNameSet(value As %String = "") as %Status
method SqlViewReset()
method SqlViewSet(value As %String = "") as %Status
method TypeIsDefined() as %Boolean
method TypeReset()
method TypeSet(value As %String = "") as %Status
method WebMethodIsDefined() as %Boolean
method WebMethodReset()
method WebMethodSet(value As %String = "") as %Status
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status


index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()


trigger OnDelete (AFTER event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new tab