Properties (Including Private)Copy link to this section
property Abstract as %Boolean ;
Copy link to this section
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 ;
Copy link to this section
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 ;
Copy link to this section
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 ;
Copy link to this section
ClientName
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property CodeMode as %CacheString ;
Copy link to this section
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 CompilerGenerated as %Boolean ;
Copy link to this section
CompilerGenerated
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property DefaultArgs as %CacheString ;
Copy link to this section
DefaultArgs
Property methods: DefaultArgsGet(), DefaultArgsIsValid(), DefaultArgsSet()
property Deprecated as %Boolean ;
Copy link to this section
True if this method is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString ;
Copy link to this section
Specifies a description of the method.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property ExternalProcName as %CacheString ;
Copy link to this section
Specifies the SQL procedure name in the foreign database.
Property methods: ExternalProcNameGet(), ExternalProcNameIsValid(), ExternalProcNameSet()
property Final as %Boolean ;
Copy link to this section
Specifies that subclasses cannot override the implementation of the method.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property ForceGenerate as %Boolean ;
Copy link to this section
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()
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(), FormalSpecParsedGet(), FormalSpecParsedIsValid(), FormalSpecParsedSet(), FormalSpecSet()
FormalSpecParsed
Property methods: FormalSpecParsedGet(), FormalSpecParsedIsValid(), FormalSpecParsedSet()
FormalType
Property methods: FormalTypeGet(), FormalTypeIsValid(), FormalTypeSet()
property GenerateAfter as %CacheString ;
Copy link to this section
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()
Hash
Property methods: HashGet(), HashIsValid(), HashSet()
property Id as %Integer ;
Copy link to this section
Id
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()
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 InheritedId as %Boolean ;
Copy link to this section
InheritedId
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property Internal as %Boolean ;
Copy link to this section
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property KeywordError as %Boolean ;
Copy link to this section
KeywordError
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean ;
Copy link to this section
KeywordModified
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
Label
Property methods: LabelGet(), LabelIsValid(), LabelSet()
property Language as %CacheString [ SqlFieldName = _Language ];
Copy link to this section
The language used to implement this method.
Property methods: LanguageGet(), LanguageIsValid(), LanguageSet()
The name of the method.
Property methods: NameGet(), NameIsValid(), NameSet()
property NoContext as %Boolean ;
Copy link to this section
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 ;
Copy link to this section
Deprecated.
Property methods: NotForPropertyDisplayToLogical(), NotForPropertyGet(), NotForPropertyIsValid(), NotForPropertyLogicalToDisplay(), NotForPropertyNormalize(), NotForPropertySet()
property NotInheritable as %Boolean ;
Copy link to this section
Specifies that this method is not inherited in subclasses.
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property OptimizedMAC as %CacheString ;
Copy link to this section
OptimizedMAC
Property methods: OptimizedMACGet(), OptimizedMACIsValid(), OptimizedMACSet()
property OptimizedRun as %CacheString ;
Copy link to this section
OptimizedRun
Property methods: OptimizedRunGet(), OptimizedRunIsValid(), OptimizedRunSet()
Origin
Property methods: OriginGet(), OriginIsValid(), OriginSet(), OriginalNameGet(), OriginalNameIsValid(), OriginalNameSet()
property OriginalName as %CacheString ;
Copy link to this section
OriginalName
Property methods: OriginalNameGet(), OriginalNameIsValid(), OriginalNameSet()
property PlaceAfter as %CacheString ;
Copy link to this section
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 ;
Copy link to this section
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 ;
Copy link to this section
Specifies that this method uses procedure block for method code.
Property methods: ProcedureBlockGet(), ProcedureBlockIsValid(), ProcedureBlockSet()
property PublicList as %CacheString ;
Copy link to this section
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 ;
Copy link to this section
If true this method may return zero, one, or more Resultsets in the %sqlcontext.
Property methods: ReturnResultsetsDisplayToLogical(), ReturnResultsetsGet(), ReturnResultsetsIsValid(), ReturnResultsetsLogicalToDisplay(), ReturnResultsetsNormalize(), ReturnResultsetsSet()
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 ;
Copy link to this section
A comma separated list of any parameters on the ReturnType keyword.
Property methods: ReturnTypeParamsGet(), ReturnTypeParamsIsValid(), ReturnTypeParamsSet()
property RtnLabel as %CacheString ;
Copy link to this section
RtnLabel
Property methods: RtnLabelGet(), RtnLabelIsValid(), RtnLabelSet()
property Runnable as %Boolean ;
Copy link to this section
Runnable
Property methods: RunnableDisplayToLogical(), RunnableGet(), RunnableIsValid(), RunnableLogicalToDisplay(), RunnableNormalize(), RunnableSet()
property RuntimeClient as %Boolean ;
Copy link to this section
RuntimeClient
Property methods: RuntimeClientDisplayToLogical(), RuntimeClientGet(), RuntimeClientIsValid(), RuntimeClientLogicalToDisplay(), RuntimeClientNormalize(), RuntimeClientSet()
property RuntimeCodeMode as %CacheString ;
Copy link to this section
CodeMode to use for generated methods
Property methods: RuntimeCodeModeGet(), RuntimeCodeModeIsValid(), RuntimeCodeModeSet()
property RuntimeHash as %CacheString ;
Copy link to this section
RuntimeHash
Property methods: RuntimeHashGet(), RuntimeHashIsValid(), RuntimeHashSet()
property RuntimeLanguage as %CacheString ;
Copy link to this section
RuntimeLanguage
Property methods: RuntimeLanguageGet(), RuntimeLanguageIsValid(), RuntimeLanguageSet()
property SequenceNumber as %Integer ;
Copy link to this section
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property ServerOnly as %CacheString ;
Copy link to this section
Specifies that a method will not be projected to a Java or C++ client.
Property methods: ServerOnlyGet(), ServerOnlyIsValid(), ServerOnlySet()
property SoapAction as %CacheString ;
Copy link to this section
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 ;
Copy link to this section
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 ;
Copy link to this section
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 ;
Copy link to this section
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 ;
Copy link to this section
Overrides the SOAPNAMESPACE class parameter for this web service or web service client.
Property methods: SoapNameSpaceGet(), SoapNameSpaceIsValid(), SoapNameSpaceSet()
property SoapRequestMessage as %CacheString ;
Copy link to this section
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 ;
Copy link to this section
Overrides the SOAPTYPENAMESPACE class parameter for this web service or web service client.
Property methods: SoapTypeNameSpaceGet(), SoapTypeNameSpaceIsValid(), SoapTypeNameSpaceSet()
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 ;
Copy link to this section
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 ;
Copy link to this section
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()
Stub
Property methods: StubGet(), StubIsValid(), StubMemberGet(), StubMemberIsValid(), StubMemberSet(), StubSet()
property StubMember as %CacheString ;
Copy link to this section
StubMember
Property methods: StubMemberGet(), StubMemberIsValid(), StubMemberSet()
property TagGenerator as %CacheString ;
Copy link to this section
TagGenerator
Property methods: TagGeneratorGet(), TagGeneratorIsValid(), TagGeneratorSet()
property UserActualType as %CacheString ;
Copy link to this section
UserActualType
Property methods: UserActualTypeGet(), UserActualTypeIsValid(), UserActualTypeSet()
property WebMethod as %Boolean ;
Copy link to this section
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 ;
Copy link to this section
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()
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()