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

%Dictionary.MethodDefinition


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

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 42 14 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 CodeModeIsValid ProcedureBlockIsValid
ServerOnlyIsValid SoapBindingStyleIsValid SoapBodyUseIsValid SqlRoutineIsValid
SummaryClose SummaryExecute SummaryFetch 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 %CacheString;
ClientName
• property CodeMode as %CacheString [ 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 %CacheString;
Specifies a description of the method.
• property ExternalProcName as %CacheString;
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 %CacheString;
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 %CacheString;
In the case of a method generator method, specifies that the generator should be invoked after the listed methods are generated.
• property Hash as %CacheString;
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 a Cache routine to call.
• property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property Language as %CacheString [ SqlFieldName = _Language ];
The language used to implement this method.
• property Name as %Dictionary.CacheIdentifier [ 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 %CacheString;
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 %CacheString;
Specifies that this method uses procedure block for method code.
• property PublicList as %CacheString;
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.CacheClassname;
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 %CacheString;
A comma separated list of any parameters on the ReturnType keyword.
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• property ServerOnly as %CacheString;
Specifies that a method will not be projected to a Java or C++ client.
• property SoapAction as %CacheString [ 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 %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 SoapMessageName as %CacheString;
Specifies the name of the child element of the body of the response message for a web service method.
• property SoapNameSpace as %CacheString;
Overrides the SOAPNAMESPACE class parameter for this web service or web service client.
• property SoapRequestMessage as %CacheString;
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 %CacheString;
Overrides the SOAPTYPENAMESPACE class parameter for this web service or web service client.
• property SqlName as %CacheString;
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 %CacheString;
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 %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 CodeModeIsValid(val As %String) as %Status
• classmethod ProcedureBlockIsValid(val As %String) as %Status
• classmethod ServerOnlyIsValid(val As %String) as %Status
• classmethod SoapBindingStyleIsValid(val As %String) as %Status
• classmethod SoapBodyUseIsValid(val As %String) as %Status
• classmethod SqlRoutineIsValid(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)