Class %Library.MethodDefinition

hidden deprecatedpersistent class %Library.MethodDefinition extends %AbstractDefinition

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package. Instead use %Dictionary.MethodDefinition.

This class represents a specific method description.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	26	13

Summary

Properties
Abstract	Call	ClassMethod	ClassName	Code
CodeMode	Deprecated	Description	Expression	Final
FormalSpec	GenerateAfter	Generator	Implementation	Internal
Language	Name	NotForProperty	NotInheritable	PlaceAfter
Private	ReadOnly	ReturnType	SQLName	SQLProc
SequenceNumber

Methods
%AddToSaveSet	%AddToSyncSet	%BuildDeferredIndices	%BuildIndices
%BuildIndicesAsync	%BuildIndicesAsyncResponse	%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	%OnDeleteFinally
%OnDetermineClass	%OnOpenFinally	%OnSaveFinally	%Open
%OpenId	%OriginalNamespace	%PackageName	%PurgeIndices
%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack
%Save	%SaveDirect	%SerializeObject	%SetModified
%SortBegin	%SortEnd	%SyncObjectIn	%SyncTransport
%UnlockExtent	%UnlockId	%ValidateIndices	%ValidateObject
%ValidateTable	CallGet	CallSet	CodeGet
CodeSet	ExpressionGet	ExpressionSet	GeneratorGet
GeneratorSet	GetTransientState	SetTransientState	lb
li	ll

Properties

• property Abstract as %RawString;

A flag indicating if this method is abstract (1) or not (0).

• property Call as %RawString [ Calculated ];

For call methods, a string containing the name of the routine to call.

• property ClassMethod as %RawString;

A flag indicating whether the method is a class method (1) or an instance method (0).

• property ClassName as %RawString;

A string containing the name of the class the method belongs to.

• property Code as %RawString [ Calculated ];

The implementation for the method.

• property CodeMode as %RawString [ InitialExpression = "code" ];

A string containing the code mode of the method.

• property Deprecated as %RawString;

A flag indicating if this method is deprecated (1) or not (0).

• property Description as %RawString;

A string containing the description of the method.

• property Expression as %RawString [ Calculated ];

• property Final as %RawString;

A flag indicating whether the method is final (1) or not (0).

• property FormalSpec as %RawString;

A string containing the list of arguments for the method.

• property GenerateAfter as %RawString;

For a method generator, a string containing the name of another method generator which should be called before this one when compiling.

• property Generator as %RawString [ Calculated ];

The implementation of the method generator for this method.

• property Implementation as %RawString;

The implementation of the method generator for this method.

• property Internal as %RawString;

A flag indicating whether the method is internal (1) or not (0).

• property Language as %RawString [ InitialExpression = "cache" ];

This is for internal use.

• property Name as %RawString;

A string containing the name of the method.

• property NotForProperty as %RawString;

This is for internal use.

• property NotInheritable as %RawString;

This is for internal use.

• property PlaceAfter as %RawString;

A string containing the name of another method which should be placed before this method in generated code.

• property Private as %RawString;

A flag indicating whether the method is private (1) or public (0).

• property ReadOnly as %RawString [ InitialExpression = 0 ];

Set to true of the implementation is too large to load into the property as you can not save this class, but you may look at the other properties

• property ReturnType as %RawString;

A string containing the return type (a class name) for the method. If there is no return type it contains a null string ("").

• property SQLName as %RawString;

A string containing the name of this method when projected as an SQLPROCEDURE.

• property SQLProc as %RawString;

A flag indicating whether the method can be called as an SQL stored procedure (1) or not (0). A stored procedure must marked as a class method.

• property SequenceNumber as %RawString;

Sequence number used to determine order of this item in Studio editor and in XML export format.

Methods

• method CallGet() as %RawString

This is a Get accessor method for the Call property.

• method CallSet(value As %RawString) as %Status

This is a Set accessor method for the Call property.

• method CodeGet() as %RawString

This is a Get accessor method for the Code property.

• method CodeSet(value As %RawString) as %Status

This is a Set accessor method for the Code property.

• method ExpressionGet() as %RawString

This is a Get accessor method for the Expression property.

• method ExpressionSet(value As %RawString) as %Status

This is a Set accessor method for the Expression property.

• method GeneratorGet() as %RawString

This is a Get accessor method for the Generator property.

• method GeneratorSet(value As %RawString) as %Status

This is a Set accessor method for the Generator property.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search