Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%Dictionary] >  [QueryDefinition]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 23 70 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 ClientNameIsDefined ClientNameReset
ClientNameSet DeprecatedIsDefined DeprecatedReset DeprecatedSet
DescriptionIsDefined DescriptionReset DescriptionSet FinalIsDefined
FinalReset FinalSet FormalSpecIsDefined FormalSpecReset
FormalSpecSet InternalIsDefined InternalReset InternalSet
NameIsDefined NameReset NameSet NotInheritableIsDefined
NotInheritableReset NotInheritableSet PrivateIsDefined PrivateReset
PrivateSet SequenceNumberIsDefined SequenceNumberReset SequenceNumberSet
SoapBindingStyleIsDefined SoapBindingStyleIsValid SoapBindingStyleReset SoapBindingStyleSet
SoapBodyUseIsDefined SoapBodyUseIsValid SoapBodyUseReset SoapBodyUseSet
SoapNameSpaceIsDefined SoapNameSpaceReset SoapNameSpaceSet SqlNameIsDefined
SqlNameReset SqlNameSet SqlProcIsDefined SqlProcReset
SqlProcSet SqlQueryIsDefined SqlQueryReset SqlQuerySet
SqlViewIsDefined SqlViewNameIsDefined SqlViewNameReset SqlViewNameSet
SqlViewReset SqlViewSet SummaryClose SummaryExecute
SummaryFetch TypeIsDefined TypeReset TypeSet
WebMethodIsDefined WebMethodReset WebMethodSet parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property ClientName as %RawString;
ClientName
• property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this query is deprecated.
• property Description as %RawString;
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 %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 Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property Name as %Dictionary.Identifier [ Required ];
The name of the query.
• property NotInheritable as %Boolean [ InitialExpression = 0 ];
Deprecated
• property Parameters as array of %RawString;
Parameter
• property Private as %Boolean [ InitialExpression = 0 ];
Deprecated.
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• 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 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 SoapNameSpace as %RawString;
SoapNameSpace
• 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 SqlProc as %Boolean [ InitialExpression = 0 ];
Specifies that the query can be invoked as an SQL stored procedure.
• property SqlQuery as %RawString;
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 %RawString;
Specifies an SQL alias for the view projected from this query.
• property Type as %Dictionary.Classname;
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 %Storage.Persistent or %Storage.SQL.
• 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 %Storage.Persistent or %Storage.SQL.
• method ClientNameIsDefined() as %Boolean
• method ClientNameReset()
• method ClientNameSet(value As %String = "") as %Status
This is a Set accessor method for the ClientName property.
• method DeprecatedIsDefined() as %Boolean
• method DeprecatedReset()
• method DeprecatedSet(value As %String = "") as %Status
This is a Set accessor method for the Deprecated property.
• method DescriptionIsDefined() as %Boolean
• method DescriptionReset()
• method DescriptionSet(value As %String = "") as %Status
This is a Set accessor method for the Description property.
• method FinalIsDefined() as %Boolean
• method FinalReset()
• method FinalSet(value As %String = "") as %Status
This is a Set accessor method for the Final property.
• method FormalSpecIsDefined() as %Boolean
• method FormalSpecReset()
• method FormalSpecSet(value As %String = "") as %Status
This is a Set accessor method for the FormalSpec property.
• method InternalIsDefined() as %Boolean
• method InternalReset()
• method InternalSet(value As %String = "") as %Status
This is a Set accessor method for the Internal property.
• method NameIsDefined() as %Boolean
• method NameReset()
• method NameSet(value As %String = "") as %Status
This is a Set accessor method for the Name property.
• method NotInheritableIsDefined() as %Boolean
• method NotInheritableReset()
• method NotInheritableSet(value As %String = "") as %Status
This is a Set accessor method for the NotInheritable property.
• method PrivateIsDefined() as %Boolean
• method PrivateReset()
• method PrivateSet(value As %String = "") as %Status
This is a Set accessor method for the Private property.
• method SequenceNumberIsDefined() as %Boolean
• method SequenceNumberReset()
• method SequenceNumberSet(value As %String = "") as %Status
This is a Set accessor method for the SequenceNumber property.
• method SoapBindingStyleIsDefined() as %Boolean
• classmethod SoapBindingStyleIsValid(val As %String) as %Status
• method SoapBindingStyleReset()
• method SoapBindingStyleSet(value As %String = "") as %Status
This is a Set accessor method for the SoapBindingStyle property.
• method SoapBodyUseIsDefined() as %Boolean
• classmethod SoapBodyUseIsValid(val As %String) as %Status
• method SoapBodyUseReset()
• method SoapBodyUseSet(value As %String = "") as %Status
This is a Set accessor method for the SoapBodyUse property.
• method SoapNameSpaceIsDefined() as %Boolean
• method SoapNameSpaceReset()
• method SoapNameSpaceSet(value As %String = "") as %Status
This is a Set accessor method for the SoapNameSpace property.
• method SqlNameIsDefined() as %Boolean
• method SqlNameReset()
• method SqlNameSet(value As %String = "") as %Status
This is a Set accessor method for the SqlName property.
• method SqlProcIsDefined() as %Boolean
• method SqlProcReset()
• method SqlProcSet(value As %String = "") as %Status
This is a Set accessor method for the SqlProc property.
• method SqlQueryIsDefined() as %Boolean
• method SqlQueryReset()
• method SqlQuerySet(value As %String = "") as %Status
This is a Set accessor method for the SqlQuery property.
• method SqlViewIsDefined() as %Boolean
• method SqlViewNameIsDefined() as %Boolean
• method SqlViewNameReset()
• method SqlViewNameSet(value As %String = "") as %Status
This is a Set accessor method for the SqlViewName property.
• method SqlViewReset()
• method SqlViewSet(value As %String = "") as %Status
This is a Set accessor method for the SqlView property.
• method TypeIsDefined() as %Boolean
• method TypeReset()
• method TypeSet(value As %String = "") as %Status
This is a Set accessor method for the Type property.
• method WebMethodIsDefined() as %Boolean
• method WebMethodReset()
• method WebMethodSet(value As %String = "") as %Status
This is a Set accessor method for the WebMethod property.
• 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)


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.