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

persistent class %Dictionary.MethodDefinition extends %Persistent, %Dictionary.MethodDefinitionQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 43 134 1 2


Summary

Properties
Abstract ClassMethod ClientMethod ClientName
CodeMode Deprecated Description ExternalProcName
Final ForceGenerate FormalSpec GenerateAfter
Hash Implementation Internal Language
Name NoContext NotForProperty NotInheritable
PlaceAfter Private ProcedureBlock PublicList
ReturnResultsets ReturnType ReturnTypeParams SequenceNumber
ServerOnly SoapAction SoapBindingStyle SoapBodyUse
SoapMessageName SoapNameSpace SoapRequestMessage SoapTypeNameSpace
SqlName SqlProc SqlRoutine WebMethod
ZenMethod 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 AbstractIsDefined AbstractReset
AbstractSet ClassMethodIsDefined ClassMethodReset ClassMethodSet
ClientMethodIsDefined ClientMethodReset ClientMethodSet ClientNameIsDefined
ClientNameReset ClientNameSet CodeModeIsDefined CodeModeIsValid
CodeModeReset CodeModeSet DeprecatedIsDefined DeprecatedReset
DeprecatedSet DescriptionIsDefined DescriptionReset DescriptionSet
ExternalProcNameIsDefined ExternalProcNameReset ExternalProcNameSet FinalIsDefined
FinalReset FinalSet ForceGenerateIsDefined ForceGenerateReset
ForceGenerateSet FormalSpecIsDefined FormalSpecReset FormalSpecSet
GenerateAfterIsDefined GenerateAfterReset GenerateAfterSet HashIsDefined
HashReset HashSet InternalIsDefined InternalReset
InternalSet LanguageIsDefined LanguageReset LanguageSet
NameIsDefined NameReset NameSet NoContextIsDefined
NoContextReset NoContextSet NotForPropertyIsDefined NotForPropertyReset
NotForPropertySet NotInheritableIsDefined NotInheritableReset NotInheritableSet
PlaceAfterIsDefined PlaceAfterReset PlaceAfterSet PrivateIsDefined
PrivateReset PrivateSet ProcedureBlockIsDefined ProcedureBlockIsValid
ProcedureBlockReset ProcedureBlockSet PublicListIsDefined PublicListReset
PublicListSet ReturnResultsetsIsDefined ReturnResultsetsReset ReturnResultsetsSet
ReturnTypeIsDefined ReturnTypeParamsIsDefined ReturnTypeParamsReset ReturnTypeParamsSet
ReturnTypeReset ReturnTypeSet SequenceNumberIsDefined SequenceNumberReset
SequenceNumberSet ServerOnlyIsDefined ServerOnlyIsValid ServerOnlyReset
ServerOnlySet SoapActionIsDefined SoapActionReset SoapActionSet
SoapBindingStyleIsDefined SoapBindingStyleIsValid SoapBindingStyleReset SoapBindingStyleSet
SoapBodyUseIsDefined SoapBodyUseIsValid SoapBodyUseReset SoapBodyUseSet
SoapMessageNameIsDefined SoapMessageNameReset SoapMessageNameSet SoapNameSpaceIsDefined
SoapNameSpaceReset SoapNameSpaceSet SoapRequestMessageIsDefined SoapRequestMessageReset
SoapRequestMessageSet SoapTypeNameSpaceIsDefined SoapTypeNameSpaceReset SoapTypeNameSpaceSet
SqlNameIsDefined SqlNameReset SqlNameSet SqlProcIsDefined
SqlProcReset SqlProcSet SqlRoutineIsDefined SqlRoutineIsValid
SqlRoutineReset SqlRoutineSet SummaryClose SummaryExecute
SummaryFetch WebMethodIsDefined WebMethodReset WebMethodSet
ZenMethodIsDefined ZenMethodReset ZenMethodSet parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Abstract as %Boolean [ InitialExpression = 0 ];
Specifies that this is an abstract method. An abstract method has no implementation and has no executable code generated for it. Abstract methods exist solely for the purpose of defining a method signature or interface that can be overridden and implemented within one or more subclasses.
• property ClassMethod as %Boolean [ InitialExpression = 0 ];
Specifies that the method is a class method. Instance methods can only be invoked via an instantiated object while class methods can be directly invoked without an object instance.
• property ClientMethod as %Boolean [ InitialExpression = 0 ];
If true this method is only available on the server, and is to be projected as a client method.
• property ClientName as %RawString;
ClientName
• property CodeMode as %RawString [ InitialExpression = "code" ];
Specifies how a given method is implemented: as a routine call, lines of code to be compiled, an expression, or a method that will generate the resulting method or object.
• property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this method is deprecated.
• property Description as %RawString;
Specifies a description of the method.
• property ExternalProcName as %RawString;
Specifies the SQL procedure name in the foreign database.
• property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the implementation of the method.
• property ForceGenerate as %Boolean [ InitialExpression = 0 ];
When true we always regenerate this method into each subclass even if normal rules would allow us to call the superclass implementation.
• property FormalSpec as %RawString;
Specifies the list of arguments. Each argument is of the format [&|*]<name>[:<type>][=<default>] where & means pass-by-reference and * means output-only.
• property GenerateAfter as %RawString;
In the case of a method generator method, specifies that the generator should be invoked after the listed methods are generated.
• property Hash as %RawString;
Hash
• property Implementation as %Stream.TmpCharacter;
The code that is executed when the method is invoked. In the case of an expression method, this is an expression. In the case of a call method, this is the name of an ObjectScript routine to call.
• property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property Language as %RawString [ SqlFieldName = _Language ];
The language used to implement this method.
• property Name as %Dictionary.Identifier [ Required ];
The name of the method.
• property NoContext as %Boolean [ InitialExpression = 0 ];
If true and in a datatype method, this prevents the * Set %val=..prop Set $this="" * that is added to the property method so you can override things like the Get/Set methods.
• property NotForProperty as %Boolean [ InitialExpression = 0 ];
Deprecated.
• property NotInheritable as %Boolean [ InitialExpression = 0 ];
Specifies that this method is not inherited in subclasses.
• property PlaceAfter as %RawString;
Specifies that the class compiler should place this method after the listed methods in the routine it creates for the class.
• property Private as %Boolean [ InitialExpression = 0 ];
Specifies that the method is private. Private methods can only be invoked by instance methods of this class or its subclasses.
• property ProcedureBlock as %RawString;
Specifies that this method uses procedure block for method code.
• property PublicList as %RawString;
Specifies the public list. This keyword is used only if the ProcedureBlock keyword is set to true.
• property ReturnResultsets as %Boolean [ InitialExpression = 0 ];
If true this method may return zero, one, or more Resultsets in the %sqlcontext.
• property ReturnType as %Dictionary.Classname;
Specifies the data type of the value returned by a call to the method. Setting ReturnType to an empty string specifies that there is no return value.
• property ReturnTypeParams as %RawString;
A comma separated list of any parameters on the ReturnType keyword.
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• property ServerOnly as %RawString;
Specifies that a method will not be projected to a Java or C++ client.
• property SoapAction as %RawString [ InitialExpression = "[default]" ];
Lets you specify the HTTP SOAP action that must be used when invoking this web service method as a web method. For SOAP 1.1, the SOAP action is obtained from the SOAPAction HTTP header. For SOAP 1.2, it is obtained from the Content-Type HTTP header.
• 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 SoapMessageName as %RawString;
Specifies the name of the child element of the body of the response message for a web service method.
• property SoapNameSpace as %RawString;
Overrides the SOAPNAMESPACE class parameter for this web service or web service client.
• property SoapRequestMessage as %RawString;
This keyword will reflects the expected element name for top element of the SOAP body in the SOAP request. This element is needed to distinguish between multiple requests which have the same SoapAction but different top level body elements.
• property SoapTypeNameSpace as %RawString;
Overrides the SOAPTYPENAMESPACE class parameter for this web service or web service client.
• property SqlName as %RawString;
If this method 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 method can be invoked as an SQL stored procedure. Only class methods can be called as SQL stored procedures.
• property SqlRoutine as %RawString;
If 'procedure' then this is equivalent to SqlProc keyword and means class method can be called as an SQL procedure. If 'function' then this class method can be called as an SQL function.
• property WebMethod as %Boolean [ InitialExpression = 0 ];
Specifies that a method can be invoked as a web method using the SOAP protocol.
• property ZenMethod as %Boolean [ InitialExpression = 0 ];
Specifies that the method should be projected to the web client for use in the Zen framework.
• relationship parent as %Dictionary.ClassDefinition [ Inverse = Methods,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 AbstractIsDefined() as %Boolean
• method AbstractReset()
• method AbstractSet(value As %String = "") as %Status
This is a Set accessor method for the Abstract property.
• method ClassMethodIsDefined() as %Boolean
• method ClassMethodReset()
• method ClassMethodSet(value As %String = "") as %Status
This is a Set accessor method for the ClassMethod property.
• method ClientMethodIsDefined() as %Boolean
• method ClientMethodReset()
• method ClientMethodSet(value As %String = "") as %Status
This is a Set accessor method for the ClientMethod property.
• method ClientNameIsDefined() as %Boolean
• method ClientNameReset()
• method ClientNameSet(value As %String = "") as %Status
This is a Set accessor method for the ClientName property.
• method CodeModeIsDefined() as %Boolean
• classmethod CodeModeIsValid(val As %String) as %Status
• method CodeModeReset()
• method CodeModeSet(value As %String = "") as %Status
This is a Set accessor method for the CodeMode 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 ExternalProcNameIsDefined() as %Boolean
• method ExternalProcNameReset()
• method ExternalProcNameSet(value As %String = "") as %Status
This is a Set accessor method for the ExternalProcName 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 ForceGenerateIsDefined() as %Boolean
• method ForceGenerateReset()
• method ForceGenerateSet(value As %String = "") as %Status
This is a Set accessor method for the ForceGenerate 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 GenerateAfterIsDefined() as %Boolean
• method GenerateAfterReset()
• method GenerateAfterSet(value As %String = "") as %Status
This is a Set accessor method for the GenerateAfter property.
• method HashIsDefined() as %Boolean
• method HashReset()
• method HashSet(value As %String = "") as %Status
This is a Set accessor method for the Hash 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 LanguageIsDefined() as %Boolean
• method LanguageReset()
• method LanguageSet(value As %String = "") as %Status
This is a Set accessor method for the Language 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 NoContextIsDefined() as %Boolean
• method NoContextReset()
• method NoContextSet(value As %String = "") as %Status
This is a Set accessor method for the NoContext property.
• method NotForPropertyIsDefined() as %Boolean
• method NotForPropertyReset()
• method NotForPropertySet(value As %String = "") as %Status
This is a Set accessor method for the NotForProperty 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 PlaceAfterIsDefined() as %Boolean
• method PlaceAfterReset()
• method PlaceAfterSet(value As %String = "") as %Status
This is a Set accessor method for the PlaceAfter 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 ProcedureBlockIsDefined() as %Boolean
• classmethod ProcedureBlockIsValid(val As %String) as %Status
• method ProcedureBlockReset()
• method ProcedureBlockSet(value As %String = "") as %Status
This is a Set accessor method for the ProcedureBlock property.
• method PublicListIsDefined() as %Boolean
• method PublicListReset()
• method PublicListSet(value As %String = "") as %Status
This is a Set accessor method for the PublicList property.
• method ReturnResultsetsIsDefined() as %Boolean
• method ReturnResultsetsReset()
• method ReturnResultsetsSet(value As %String = "") as %Status
This is a Set accessor method for the ReturnResultsets property.
• method ReturnTypeIsDefined() as %Boolean
• method ReturnTypeParamsIsDefined() as %Boolean
• method ReturnTypeParamsReset()
• method ReturnTypeParamsSet(value As %String = "") as %Status
This is a Set accessor method for the ReturnTypeParams property.
• method ReturnTypeReset()
• method ReturnTypeSet(value As %String = "") as %Status
This is a Set accessor method for the ReturnType 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 ServerOnlyIsDefined() as %Boolean
• classmethod ServerOnlyIsValid(val As %String) as %Status
• method ServerOnlyReset()
• method ServerOnlySet(value As %String = "") as %Status
This is a Set accessor method for the ServerOnly property.
• method SoapActionIsDefined() as %Boolean
• method SoapActionReset()
• method SoapActionSet(value As %String = "") as %Status
This is a Set accessor method for the SoapAction 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 SoapMessageNameIsDefined() as %Boolean
• method SoapMessageNameReset()
• method SoapMessageNameSet(value As %String = "") as %Status
This is a Set accessor method for the SoapMessageName 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 SoapRequestMessageIsDefined() as %Boolean
• method SoapRequestMessageReset()
• method SoapRequestMessageSet(value As %String = "") as %Status
This is a Set accessor method for the SoapRequestMessage property.
• method SoapTypeNameSpaceIsDefined() as %Boolean
• method SoapTypeNameSpaceReset()
• method SoapTypeNameSpaceSet(value As %String = "") as %Status
This is a Set accessor method for the SoapTypeNameSpace 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 SqlRoutineIsDefined() as %Boolean
• classmethod SqlRoutineIsValid(val As %String) as %Status
• method SqlRoutineReset()
• method SqlRoutineSet(value As %String = "") as %Status
This is a Set accessor method for the SqlRoutine property.
• method WebMethodIsDefined() as %Boolean
• method WebMethodReset()
• method WebMethodSet(value As %String = "") as %Status
This is a Set accessor method for the WebMethod property.
• method ZenMethodIsDefined() as %Boolean
• method ZenMethodReset()
• method ZenMethodSet(value As %String = "") as %Status
This is a Set accessor method for the ZenMethod 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.