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

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).

%Dictionary.MethodDefinition

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

SQL Table Name: %Dictionary.MethodDefinition

Property Inventory (Including Private)

Method Inventory (Including Private)

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 methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractSet()
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 methods: ClassMethodDisplayToLogical(), ClassMethodGet(), ClassMethodIsValid(), ClassMethodLogicalToDisplay(), ClassMethodNormalize(), ClassMethodSet()
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 methods: ClientMethodDisplayToLogical(), ClientMethodGet(), ClientMethodIsValid(), ClientMethodLogicalToDisplay(), ClientMethodNormalize(), ClientMethodSet()
property ClientName as %CacheString;
ClientName
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
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 methods: CodeModeGet(), CodeModeIsValid(), CodeModeSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this method is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the method.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property ExternalProcName as %CacheString;
Specifies the SQL procedure name in the foreign database.
Property methods: ExternalProcNameGet(), ExternalProcNameIsValid(), ExternalProcNameSet()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the implementation of the method.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
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 methods: ForceGenerateDisplayToLogical(), ForceGenerateGet(), ForceGenerateIsValid(), ForceGenerateLogicalToDisplay(), ForceGenerateNormalize(), ForceGenerateSet()
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 methods: FormalSpecGet(), FormalSpecIsValid(), FormalSpecSet()
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 methods: GenerateAfterGet(), GenerateAfterIsValid(), GenerateAfterSet()
property Hash as %CacheString;
Hash
Property methods: HashGet(), HashIsValid(), HashSet()
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 methods: ImplementationDelete(), ImplementationGet(), ImplementationGetObject(), ImplementationGetObjectId(), ImplementationGetSwizzled(), ImplementationIsValid(), ImplementationNewObject(), ImplementationOid(), ImplementationOpen(), ImplementationSet(), ImplementationSetObject(), ImplementationSetObjectId(), ImplementationUnSwizzle()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property Language as %CacheString [ SqlFieldName = _Language ];
The language used to implement this method.
Property methods: LanguageGet(), LanguageIsValid(), LanguageSet()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the method.
Property methods: NameGet(), NameIsValid(), NameSet()
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 methods: NoContextDisplayToLogical(), NoContextGet(), NoContextIsValid(), NoContextLogicalToDisplay(), NoContextNormalize(), NoContextSet()
property NotForProperty as %Boolean [ InitialExpression = 0 ];
Deprecated.
Property methods: NotForPropertyDisplayToLogical(), NotForPropertyGet(), NotForPropertyIsValid(), NotForPropertyLogicalToDisplay(), NotForPropertyNormalize(), NotForPropertySet()
property NotInheritable as %Boolean [ InitialExpression = 0 ];
Specifies that this method is not inherited in subclasses.
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
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 methods: PlaceAfterGet(), PlaceAfterIsValid(), PlaceAfterSet()
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 methods: PrivateDisplayToLogical(), PrivateGet(), PrivateIsValid(), PrivateLogicalToDisplay(), PrivateNormalize(), PrivateSet()
property ProcedureBlock as %CacheString;
Specifies that this method uses procedure block for method code.
Property methods: ProcedureBlockGet(), ProcedureBlockIsValid(), ProcedureBlockSet()
property PublicList as %CacheString;
Specifies the public list. This keyword is used only if the ProcedureBlock keyword is set to true.
Property methods: PublicListGet(), PublicListIsValid(), PublicListSet()
property ReturnResultsets as %Boolean [ InitialExpression = 0 ];
If true this method may return zero, one, or more Resultsets in the %sqlcontext.
Property methods: ReturnResultsetsDisplayToLogical(), ReturnResultsetsGet(), ReturnResultsetsIsValid(), ReturnResultsetsLogicalToDisplay(), ReturnResultsetsNormalize(), ReturnResultsetsSet()
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 methods: ReturnTypeGet(), ReturnTypeIsValid(), ReturnTypeParamsGet(), ReturnTypeParamsIsValid(), ReturnTypeParamsSet(), ReturnTypeSet()
property ReturnTypeParams as %CacheString;
A comma separated list of any parameters on the ReturnType keyword.
Property methods: ReturnTypeParamsGet(), ReturnTypeParamsIsValid(), ReturnTypeParamsSet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property ServerOnly as %CacheString;
Specifies that a method will not be projected to a Java or C++ client.
Property methods: ServerOnlyGet(), ServerOnlyIsValid(), ServerOnlySet()
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 methods: SoapActionGet(), SoapActionIsValid(), SoapActionSet()
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 methods: SoapBindingStyleGet(), SoapBindingStyleIsValid(), SoapBindingStyleSet()
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 methods: SoapBodyUseGet(), SoapBodyUseIsValid(), SoapBodyUseSet()
property SoapMessageName as %CacheString;
Specifies the name of the child element of the body of the response message for a web service method.
Property methods: SoapMessageNameGet(), SoapMessageNameIsValid(), SoapMessageNameSet()
property SoapNameSpace as %CacheString;
Overrides the SOAPNAMESPACE class parameter for this web service or web service client.
Property methods: SoapNameSpaceGet(), SoapNameSpaceIsValid(), SoapNameSpaceSet()
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 methods: SoapRequestMessageGet(), SoapRequestMessageIsValid(), SoapRequestMessageSet()
property SoapTypeNameSpace as %CacheString;
Overrides the SOAPTYPENAMESPACE class parameter for this web service or web service client.
Property methods: SoapTypeNameSpaceGet(), SoapTypeNameSpaceIsValid(), SoapTypeNameSpaceSet()
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 methods: SqlNameGet(), SqlNameIsValid(), SqlNameSet()
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 methods: SqlProcDisplayToLogical(), SqlProcGet(), SqlProcIsValid(), SqlProcLogicalToDisplay(), SqlProcNormalize(), SqlProcSet()
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 methods: SqlRoutineGet(), SqlRoutineIsValid(), SqlRoutineSet()
property WebMethod as %Boolean [ InitialExpression = 0 ];
Specifies that a method can be invoked as a web method using the SOAP protocol.
Property methods: WebMethodDisplayToLogical(), WebMethodGet(), WebMethodIsValid(), WebMethodLogicalToDisplay(), WebMethodNormalize(), WebMethodSet()
property ZenMethod as %Boolean [ InitialExpression = 0 ];
Specifies that the method should be projected to the web client for use in the Zen framework.
Property methods: ZenMethodDisplayToLogical(), ZenMethodGet(), ZenMethodIsValid(), ZenMethodLogicalToDisplay(), ZenMethodNormalize(), ZenMethodSet()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = Methods , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

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.
classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Inherited description: 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.

private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
Inherited description: 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.
private method %OnNew(name 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 %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.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
Inherited description: 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, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Triggers

trigger OnDelete (AFTER event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods (Including Private)

Feedback