Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > %Dictionary.QueryDefinition
Private  Storage   

%Dictionary.QueryDefinition


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

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 22 10 1 2


Summary


Properties
ClientName Deprecated Description Final
FormalSpec Internal Name NotInheritable
Parameters Private SequenceNumber SoapBindingStyle
SoapBodyUse SoapNameSpace SqlName SqlProc
SqlQuery SqlView SqlViewName Type
WebMethod parent

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%IsA %IsModified %IsNull %KillExtent
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject SoapBindingStyleIsValid SoapBodyUseIsValid
SummaryClose SummaryExecute SummaryFetch parentOnDelete


Parameters


• parameter SQLENABLED = 1;

Properties


• property ClientName as %CacheString;
ClientName
• property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this query is deprecated.
• property Description as %CacheString;
Specifies a description of the query.
• property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the query.
• 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 Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the query.
• property NotInheritable as %Boolean [ InitialExpression = 0 ];
Deprecated
• property Parameters as array of %CacheString;
Parameter
• property Private as %Boolean [ InitialExpression = 0 ];
Deprecated.
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• 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 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 SoapNameSpace as %CacheString;
SoapNameSpace
• 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 SqlProc as %Boolean [ InitialExpression = 0 ];
Specifies that the query can be invoked as an SQL stored procedure.
• property SqlQuery as %CacheString;
Specifies an SQL statement to be used for an SQL-based query.
• property SqlView as %Boolean [ InitialExpression = 0 ];
Specifies whether to project this query as an SQL View.
• property SqlViewName as %CacheString;
Specifies an SQL alias for the view projected from this query.
• property Type as %Dictionary.CacheClassname;
Specifies the Query class used to provide the implementation of the query interface.
• property WebMethod as %Boolean [ InitialExpression = 0 ];
description=Specifies that this query can be invoked using the SOAP protocol.
• relationship parent as %Dictionary.ClassDefinition [ Inverse = Queries,Cardinality = parent ];
Pointer to the containing parent object

Methods


• classmethod %Exists(oid As %ObjectIdentity) as %Boolean
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
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 %Library.CacheStorage or %Library.CacheSQLStorage.
• classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
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 %Library.CacheStorage or %Library.CacheSQLStorage.
• classmethod SoapBindingStyleIsValid(val As %String) as %Status
• classmethod SoapBodyUseIsValid(val As %String) as %Status
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices


• index (IDKEY on Name) [IdKey];

Triggers


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