This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

%Library.MethodDefinition

persistent class %Library.MethodDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.MethodDefinition

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

This class represents a specific method description for a class contained within the Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property Abstract as %CacheString;
A flag indicating if this method is abstract (1) or not (0).
Property methods: AbstractGet(), AbstractIsValid(), AbstractSet()
property Call as %CacheString [ Calculated ];
For call methods, a string containing the name of the routine to call.
Property methods: CallGet(), CallSet()
property ClassMethod as %CacheString;
A flag indicating whether the method is a class method (1) or an instance method (0).
Property methods: ClassMethodGet(), ClassMethodIsValid(), ClassMethodSet()
property ClassName as %CacheString;
A string containing the name of the class the method belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Code as %CacheString [ Calculated ];
The implementation for the method.
Property methods: CodeGet(), CodeModeGet(), CodeModeIsValid(), CodeModeSet(), CodeSet()
property CodeMode as %CacheString [ InitialExpression = "code" ];
A string containing the code mode of the method.
Property methods: CodeModeGet(), CodeModeIsValid(), CodeModeSet()
property Description as %CacheString;
A string containing the description of the method.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Expression as %CacheString [ Calculated ];
Property methods: ExpressionGet(), ExpressionSet()
property Final as %CacheString;
A flag indicating whether the method is final (1) or not (0).
Property methods: FinalGet(), FinalIsValid(), FinalSet()
property FormalSpec as %CacheString;
A string containing the list of arguments for the method.
Property methods: FormalSpecGet(), FormalSpecIsValid(), FormalSpecSet()
property GenerateAfter as %CacheString;
For a method generator, a string containing the name of another method generator which should be called before this one when compiling.
Property methods: GenerateAfterGet(), GenerateAfterIsValid(), GenerateAfterSet()
property Generator as %CacheString [ Calculated ];
The implementation of the method generator for this method.
Property methods: GeneratorGet(), GeneratorSet()
property Implementation as %CacheString;
The implementation of the method generator for this method.
Property methods: ImplementationGet(), ImplementationIsValid(), ImplementationSet()
property Internal as %CacheString;
A flag indicating whether the method is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
property Language as %CacheString [ InitialExpression = "cache" ];
This is for internal use.
Property methods: LanguageGet(), LanguageIsValid(), LanguageSet()
property Name as %CacheString;
A string containing the name of the method.
Property methods: NameGet(), NameIsValid(), NameSet()
property NotForProperty as %CacheString;
This is for internal use.
Property methods: NotForPropertyGet(), NotForPropertyIsValid(), NotForPropertySet()
property NotInheritable as %CacheString;
This is for internal use.
Property methods: NotInheritableGet(), NotInheritableIsValid(), NotInheritableSet()
property PlaceAfter as %CacheString;
A string containing the name of another method which should be placed before this method in generated code.
Property methods: PlaceAfterGet(), PlaceAfterIsValid(), PlaceAfterSet()
property Private as %CacheString;
A flag indicating whether the method is private (1) or public (0).
Property methods: PrivateGet(), PrivateIsValid(), PrivateSet()
property ReadOnly as %CacheString [ 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 methods: ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlySet()
property ReturnType as %CacheString;
A string containing the return type (a class name) for the method. If there is no return type it contains a null string ("").
Property methods: ReturnTypeGet(), ReturnTypeIsValid(), ReturnTypeSet()
property SQLName as %CacheString;
A string containing the name of this method when projected as an SQLPROCEDURE.
Property methods: SQLNameGet(), SQLNameIsValid(), SQLNameSet()
property SQLProc as %CacheString;
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 methods: SQLProcGet(), SQLProcIsValid(), SQLProcSet()
property SequenceNumber as %CacheString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
Property methods: SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberSet()

Methods

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
private method %OnNew(initvalue As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %OnValidateObject() as %Status
Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
method CallGet() as %CacheString
method CallSet(value As %CacheString) as %Status
method CodeGet() as %CacheString
method CodeSet(value As %CacheString) as %Status
method ExpressionGet() as %CacheString
method ExpressionSet(value As %CacheString) as %Status
method GeneratorGet() as %CacheString
method GeneratorSet(value As %CacheString) as %Status

Indices

index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (%Library.AbstractDefinition)

^%Library.AbstractDefinitionD(ID)
=
%%CLASSNAME
Feedback