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


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

SQL Table Name: %Dictionary.QueryDefinition

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter SQLENABLED = 1;

Properties (Including Private)

property ClientName as %CacheString;
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this query is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the query.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the query.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property FormalSpec as %CacheString;
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(), FormalSpecSet()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the query.
Property methods: NameGet(), NameIsValid(), NameSet()
property NotInheritable as %Boolean [ InitialExpression = 0 ];
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Parameters as array of %CacheString;
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(), PrivateSet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property SoapBindingStyle as %CacheString;
Specifies what type of SOAP invocation is used for a web method. This keyword is ignored for non-web methods.
Property methods: SoapBindingStyleGet(), SoapBindingStyleIsValid(), SoapBindingStyleSet()
property SoapBodyUse as %CacheString;
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(), SoapBodyUseIsValid(), SoapBodyUseSet()
property SoapNameSpace as %CacheString;
Property methods: SoapNameSpaceGet(), SoapNameSpaceIsValid(), SoapNameSpaceSet()
property SqlName as %CacheString;
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(), SqlNameSet()
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(), SqlProcSet()
property SqlQuery as %CacheString;
Specifies an SQL statement to be used for an SQL-based query.
Property methods: SqlQueryGet(), SqlQueryIsValid(), SqlQuerySet()
property SqlView as %Boolean [ InitialExpression = 0 ];
Specifies whether to project this query as an SQL View.
Property methods: SqlViewDisplayToLogical(), SqlViewGet(), SqlViewIsValid(), SqlViewLogicalToDisplay(), SqlViewNameGet(), SqlViewNameIsValid(), SqlViewNameSet(), SqlViewNormalize(), SqlViewSet()
property SqlViewName as %CacheString;
Specifies an SQL alias for the view projected from this query.
Property methods: SqlViewNameGet(), SqlViewNameIsValid(), SqlViewNameSet()
property Type as %Dictionary.CacheClassname;
Specifies the Query class used to provide the implementation of the query interface.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
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(), WebMethodSet()