%Dictionary.CompiledIndexMethod
Class %Dictionary.CompiledIndexMethod Extends %Persistent [ StorageStrategy = custom, System = 2 ]
Parameters
SQLENABLED
Parameter SQLENABLED = 1;
Properties
parent
Relationship parent As %Dictionary.CompiledIndex [ Cardinality = parent, Inverse = Methods ];
Pointer to the containing parent object
%isDefined
Property %isDefined As %RawString [ MultiDimensional, Private, Transient ];
Stores the DEFINED state of each attribute.
Abstract
Property Abstract As %Boolean;
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.
ClassMethod
Property ClassMethod As %Boolean;
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.
ClientMethod
Property ClientMethod As %Boolean;
If true this method is only available on the server, and is to be projected as a client method.
ClientName
Property ClientName As %RawString;
An alias used by client projections of this method.
CodeMode
Property CodeMode As %RawString;
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.
CompilerGenerated
Property CompilerGenerated As %Boolean;
CompilerGenerated
DefaultArgs
Property DefaultArgs As %RawString;
DefaultArgs
Deprecated
Property Deprecated As %Boolean;
True if this method is deprecated.
Description
Property Description As %RawString;
Specifies a description of the method.
ExternalProcName
Property ExternalProcName As %RawString;
Specifies the SQL procedure name in the foreign database.
Final
Property Final As %Boolean;
Specifies that subclasses cannot override the implementation of the method.
ForceGenerate
Property ForceGenerate As %Boolean;
When true we always regenerate this method into each subclass even if normal rules would allow us to call the superclass implementation.
FormalSpec
Property FormalSpec As %RawString;
Specifies the list of arguments. Each argument is of the format [&|*]
FormalSpecParsed
Property FormalSpecParsed As %RawString;
FormalSpecParsed
FormalType
Property FormalType As %RawString;
FormalType
GenerateAfter
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.
Hash
Property Hash As %RawString;
Hash
Id
Property Id As %Integer;
Id
Implementation
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.
InheritedId
Property InheritedId As %Boolean;
InheritedId
Internal
Property Internal As %Boolean;
If true, then do not display this item in automatic documentation.
KeywordError
Property KeywordError As %Boolean;
KeywordError
KeywordModified
Property KeywordModified As %Boolean;
KeywordModified
Label
Property Label As %RawString;
Label
Language
Property Language As %RawString [ SqlFieldName = _Language ];
The language used to implement this method.
Name
Property Name As %Dictionary.Identifier [ Required ];
The name of the method.
NoContext
Property NoContext As %Boolean;
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.
NotForProperty
Property NotForProperty As %Boolean;
Deprecated.
NotInheritable
Property NotInheritable As %Boolean;
Specifies that this method is not inherited in subclasses.
OptimizedMAC
Property OptimizedMAC As %RawString;
OptimizedMAC
OptimizedRun
Property OptimizedRun As %RawString;
OptimizedRun
Origin
Property Origin As %RawString;
Origin
OriginalName
Property OriginalName As %RawString;
OriginalName
PlaceAfter
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.
Private
Property Private As %Boolean;
Specifies that the method is private. Private methods can only be invoked by instance methods of this class or its subclasses.
ProcedureBlock
Property ProcedureBlock As %RawString;
Specifies that this method uses procedure block for method code.
PublicList
Property PublicList As %RawString;
Specifies the public list. This keyword is used only if the ProcedureBlock keyword is set to true.
Requires
Property Requires As %RawString;
Comma separated string of resource constraints to run this method
ReturnResultsets
Property ReturnResultsets As %Boolean;
If true this method may return zero, one, or more Resultsets in the %sqlcontext.
ReturnType
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.
ReturnTypeParams
Property ReturnTypeParams As %RawString;
A comma separated list of any parameters on the ReturnType keyword.
RtnLabel
Property RtnLabel As %RawString;
RtnLabel
Runnable
Property Runnable As %Integer;
Runnable
RuntimeClient
Property RuntimeClient As %Boolean;
RuntimeClient
RuntimeCodeMode
Property RuntimeCodeMode As %RawString;
CodeMode to use for generated methods
RuntimeHash
Property RuntimeHash As %RawString;
RuntimeHash
RuntimeLanguage
Property RuntimeLanguage As %RawString;
RuntimeLanguage
SequenceNumber
Property SequenceNumber As %Integer;
SequenceNumber
ServerOnly
Property ServerOnly As %RawString;
Specifies that a method will not be projected to a Java or C++ client.
SoapAction
Property SoapAction As %RawString;
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.
SoapBindingStyle
Property SoapBindingStyle As %RawString;
Specifies what type of SOAP invocation is used for a web method. This keyword is ignored for non-web methods.
SoapBodyUse
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.
SoapMessageName
Property SoapMessageName As %RawString;
Specifies the name of the child element of the body of the response message for a web service method.
SoapNameSpace
Property SoapNameSpace As %RawString;
Overrides the SOAPNAMESPACE class parameter for this web service or web service client.
SoapRequestMessage
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.
SoapTypeNameSpace
Property SoapTypeNameSpace As %RawString;
Overrides the SOAPTYPENAMESPACE class parameter for this web service or web service client.
SqlName
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.
SqlProc
Property SqlProc As %Boolean;
Specifies that the method can be invoked as an SQL stored procedure. Only class methods can be called as SQL stored procedures.
SqlRoutine
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.
Stub
Property Stub As %RawString;
Stub
StubMember
Property StubMember As %RawString;
StubMember
TagGenerator
Property TagGenerator As %RawString;
TagGenerator
UserActualType
Property UserActualType As %RawString;
UserActualType
WebMethod
Property WebMethod As %Boolean;
Specifies that a method can be invoked as a web method using the SOAP protocol.
ZenMethod
Property ZenMethod As %Boolean;
Specifies that the method should be projected to the web client for use in the Zen framework.
Triggers
OnInsertUpdate
Trigger OnInsertUpdate [ Event = INSERT/UPDATE ]
OnDelete
Trigger OnDelete [ Event = DELETE ]
Methods
%OnNew
Method %OnNew(name As %String) As %Status [ Private ]
%LockId
ClassMethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) As %Status
%UnlockId
ClassMethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) As %Status
%Exists
ClassMethod %Exists(oid As %ObjectIdentity) As %Boolean
%LoadData
Method %LoadData(id As %String) As %Status [ Private ]
%SaveData
Method %SaveData(id As %String) As %Status [ Private ]
%DeleteData
ClassMethod %DeleteData(id As %String, concurrency As %Integer) As %Status [ Private ]
AbstractSet
Method AbstractSet(value As %String = "") As %Status
AbstractReset
Method AbstractReset()
AbstractIsDefined
Method AbstractIsDefined() As %Boolean
ClassMethodSet
Method ClassMethodSet(value As %String = "") As %Status
ClassMethodReset
Method ClassMethodReset()
ClassMethodIsDefined
Method ClassMethodIsDefined() As %Boolean
ClientMethodSet
Method ClientMethodSet(value As %String = "") As %Status
ClientMethodReset
Method ClientMethodReset()
ClientMethodIsDefined
Method ClientMethodIsDefined() As %Boolean
ClientNameSet
Method ClientNameSet(value As %String = "") As %Status
ClientNameReset
Method ClientNameReset()
ClientNameIsDefined
Method ClientNameIsDefined() As %Boolean
CodeModeSet
Method CodeModeSet(value As %String = "") As %Status
CodeModeReset
Method CodeModeReset()
CodeModeIsDefined
Method CodeModeIsDefined() As %Boolean
DeprecatedSet
Method DeprecatedSet(value As %String = "") As %Status
DeprecatedReset
Method DeprecatedReset()
DeprecatedIsDefined
Method DeprecatedIsDefined() As %Boolean
DescriptionSet
Method DescriptionSet(value As %String = "") As %Status
DescriptionReset
Method DescriptionReset()
DescriptionIsDefined
Method DescriptionIsDefined() As %Boolean
ExternalProcNameSet
Method ExternalProcNameSet(value As %String = "") As %Status
ExternalProcNameReset
Method ExternalProcNameReset()
ExternalProcNameIsDefined
Method ExternalProcNameIsDefined() As %Boolean
FinalSet
Method FinalSet(value As %String = "") As %Status
FinalReset
Method FinalReset()
FinalIsDefined
Method FinalIsDefined() As %Boolean
ForceGenerateSet
Method ForceGenerateSet(value As %String = "") As %Status
ForceGenerateReset
Method ForceGenerateReset()
ForceGenerateIsDefined
Method ForceGenerateIsDefined() As %Boolean
FormalSpecSet
Method FormalSpecSet(value As %String = "") As %Status
FormalSpecReset
Method FormalSpecReset()
FormalSpecIsDefined
Method FormalSpecIsDefined() As %Boolean
GenerateAfterSet
Method GenerateAfterSet(value As %String = "") As %Status
GenerateAfterReset
Method GenerateAfterReset()
GenerateAfterIsDefined
Method GenerateAfterIsDefined() As %Boolean
HashSet
Method HashSet(value As %String = "") As %Status
HashReset
Method HashReset()
HashIsDefined
Method HashIsDefined() As %Boolean
InternalSet
Method InternalSet(value As %String = "") As %Status
InternalReset
Method InternalReset()
InternalIsDefined
Method InternalIsDefined() As %Boolean
LanguageSet
Method LanguageSet(value As %String = "") As %Status
LanguageReset
Method LanguageReset()
LanguageIsDefined
Method LanguageIsDefined() As %Boolean
NameSet
Method NameSet(value As %String = "") As %Status
NameReset
Method NameReset()
NameIsDefined
Method NameIsDefined() As %Boolean
NoContextSet
Method NoContextSet(value As %String = "") As %Status
NoContextReset
Method NoContextReset()
NoContextIsDefined
Method NoContextIsDefined() As %Boolean
NotForPropertySet
Method NotForPropertySet(value As %String = "") As %Status
NotForPropertyReset
Method NotForPropertyReset()
NotForPropertyIsDefined
Method NotForPropertyIsDefined() As %Boolean
NotInheritableSet
Method NotInheritableSet(value As %String = "") As %Status
NotInheritableReset
Method NotInheritableReset()
NotInheritableIsDefined
Method NotInheritableIsDefined() As %Boolean
PlaceAfterSet
Method PlaceAfterSet(value As %String = "") As %Status
PlaceAfterReset
Method PlaceAfterReset()
PlaceAfterIsDefined
Method PlaceAfterIsDefined() As %Boolean
PrivateSet
Method PrivateSet(value As %String = "") As %Status
PrivateReset
Method PrivateReset()
PrivateIsDefined
Method PrivateIsDefined() As %Boolean
ProcedureBlockSet
Method ProcedureBlockSet(value As %String = "") As %Status
ProcedureBlockReset
Method ProcedureBlockReset()
ProcedureBlockIsDefined
Method ProcedureBlockIsDefined() As %Boolean
PublicListSet
Method PublicListSet(value As %String = "") As %Status
PublicListReset
Method PublicListReset()
PublicListIsDefined
Method PublicListIsDefined() As %Boolean
RequiresSet
Method RequiresSet(value As %String = "") As %Status
RequiresReset
Method RequiresReset()
RequiresIsDefined
Method RequiresIsDefined() As %Boolean
ReturnResultsetsSet
Method ReturnResultsetsSet(value As %String = "") As %Status
ReturnResultsetsReset
Method ReturnResultsetsReset()
ReturnResultsetsIsDefined
Method ReturnResultsetsIsDefined() As %Boolean
ReturnTypeSet
Method ReturnTypeSet(value As %String = "") As %Status
ReturnTypeReset
Method ReturnTypeReset()
ReturnTypeIsDefined
Method ReturnTypeIsDefined() As %Boolean
ReturnTypeParamsSet
Method ReturnTypeParamsSet(value As %String = "") As %Status
ReturnTypeParamsReset
Method ReturnTypeParamsReset()
ReturnTypeParamsIsDefined
Method ReturnTypeParamsIsDefined() As %Boolean
SequenceNumberSet
Method SequenceNumberSet(value As %String = "") As %Status
SequenceNumberReset
Method SequenceNumberReset()
SequenceNumberIsDefined
Method SequenceNumberIsDefined() As %Boolean
ServerOnlySet
Method ServerOnlySet(value As %String = "") As %Status
ServerOnlyReset
Method ServerOnlyReset()
ServerOnlyIsDefined
Method ServerOnlyIsDefined() As %Boolean
SoapActionSet
Method SoapActionSet(value As %String = "") As %Status
SoapActionReset
Method SoapActionReset()
SoapActionIsDefined
Method SoapActionIsDefined() As %Boolean
SoapBindingStyleSet
Method SoapBindingStyleSet(value As %String = "") As %Status
SoapBindingStyleReset
Method SoapBindingStyleReset()
SoapBindingStyleIsDefined
Method SoapBindingStyleIsDefined() As %Boolean
SoapBodyUseSet
Method SoapBodyUseSet(value As %String = "") As %Status
SoapBodyUseReset
Method SoapBodyUseReset()
SoapBodyUseIsDefined
Method SoapBodyUseIsDefined() As %Boolean
SoapMessageNameSet
Method SoapMessageNameSet(value As %String = "") As %Status
SoapMessageNameReset
Method SoapMessageNameReset()
SoapMessageNameIsDefined
Method SoapMessageNameIsDefined() As %Boolean
SoapNameSpaceSet
Method SoapNameSpaceSet(value As %String = "") As %Status
SoapNameSpaceReset
Method SoapNameSpaceReset()
SoapNameSpaceIsDefined
Method SoapNameSpaceIsDefined() As %Boolean
SoapRequestMessageSet
Method SoapRequestMessageSet(value As %String = "") As %Status
SoapRequestMessageReset
Method SoapRequestMessageReset()
SoapRequestMessageIsDefined
Method SoapRequestMessageIsDefined() As %Boolean
SoapTypeNameSpaceSet
Method SoapTypeNameSpaceSet(value As %String = "") As %Status
SoapTypeNameSpaceReset
Method SoapTypeNameSpaceReset()
SoapTypeNameSpaceIsDefined
Method SoapTypeNameSpaceIsDefined() As %Boolean
SqlNameSet
Method SqlNameSet(value As %String = "") As %Status
SqlNameReset
Method SqlNameReset()
SqlNameIsDefined
Method SqlNameIsDefined() As %Boolean
SqlProcSet
Method SqlProcSet(value As %String = "") As %Status
SqlProcReset
Method SqlProcReset()
SqlProcIsDefined
Method SqlProcIsDefined() As %Boolean
SqlRoutineSet
Method SqlRoutineSet(value As %String = "") As %Status
SqlRoutineReset
Method SqlRoutineReset()
SqlRoutineIsDefined
Method SqlRoutineIsDefined() As %Boolean
WebMethodSet
Method WebMethodSet(value As %String = "") As %Status
WebMethodReset
Method WebMethodReset()
WebMethodIsDefined
Method WebMethodIsDefined() As %Boolean
ZenMethodSet
Method ZenMethodSet(value As %String = "") As %Status
ZenMethodReset
Method ZenMethodReset()
ZenMethodIsDefined
Method ZenMethodIsDefined() As %Boolean
parentOnDelete
ClassMethod parentOnDelete(id As %String, concurrency As %Integer) As %Status