IRISLIB database
CompiledQueryMethod Class Reference
Inheritance diagram for CompiledQueryMethod:
Collaboration diagram for CompiledQueryMethod:

Public Attributes

 Abstract
 Specifies that this is an abstract method. More...
 
 ClassMethod
 Specifies that the method is a class method. More...
 
 ClientMethod
 If true this method is only available on the server, and is to be projected as a client method. More...
 
 ClientName
 An alias used by client projections of this method. More...
 
 CodeMode
 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. More...
 
 CompilerGenerated
 CompilerGenerated. More...
 
 DefaultArgs
 DefaultArgs. More...
 
 Deprecated
 True if this method is deprecated. More...
 
 Description
 Specifies a description of the method. More...
 
 ExternalProcName
 Specifies the SQL procedure name in the foreign database. More...
 
 Final
 Specifies that subclasses cannot override the implementation of the method. More...
 
 ForceGenerate
 When true we always regenerate this method into each subclass even if normal rules would allow us to call the superclass implementation. More...
 
 FormalSpec
 Specifies the list of arguments. More...
 
 FormalSpecParsed
 FormalSpecParsed. More...
 
 FormalType
 FormalType. More...
 
 GenerateAfter
 In the case of a method generator method, specifies that the generator should be invoked after the listed methods are generated. More...
 
 Hash
 Hash. More...
 
 Id
 Id. More...
 
 Implementation
 The code that is executed when the method is invoked. More...
 
 InheritedId
 InheritedId. More...
 
 Internal
 If true, then do not display this item in automatic documentation. More...
 
 KeywordError
 KeywordError. More...
 
 KeywordModified
 KeywordModified. More...
 
 Label
 Label. More...
 
 Language
 The language used to implement this method. More...
 
 Name
 The name of the method. More...
 
 NoContext
 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. More...
 
 NotForProperty
 Deprecated. More...
 
 NotInheritable
 Specifies that this method is not inherited in subclasses. More...
 
 OptimizedMAC
 OptimizedMAC. More...
 
 OptimizedRun
 OptimizedRun. More...
 
 Origin
 Origin. More...
 
 OriginalName
 OriginalName. More...
 
 PlaceAfter
 Specifies that the class compiler should place this method after the listed methods in the routine it creates for the class. More...
 
 Private
 Specifies that the method is private. More...
 
 ProcedureBlock
 Specifies that this method uses procedure block for method code. More...
 
 PublicList
 Specifies the public list. More...
 
 Requires
 Comma separated string of resource constraints to run this method. More...
 
 ReturnResultsets
 If true this method may return zero, one, or more Resultsets in the sqlcontext. More...
 
 ReturnType
 Specifies the data type of the value returned by a call to the method. More...
 
 ReturnTypeParams
 A comma separated list of any parameters on the ReturnType keyword. More...
 
 RtnLabel
 RtnLabel. More...
 
 Runnable
 Runnable. More...
 
 RuntimeClient
 RuntimeClient. More...
 
 RuntimeCodeMode
 CodeMode to use for generated methods. More...
 
 RuntimeHash
 RuntimeHash. More...
 
 RuntimeLanguage
 RuntimeLanguage. More...
 
 SequenceNumber
 SequenceNumber. More...
 
 ServerOnly
 Specifies that a method will not be projected to a Java or C++ client. More...
 
 SoapAction
 Lets you specify the HTTP SOAP action that must be used when invoking this web service method as a web method. More...
 
 SoapBindingStyle
 Specifies what type of SOAP invocation is used for a web method. More...
 
 SoapBodyUse
 Specifies what kind of SOAP encoding is used for the inputs and outputs of a web method. More...
 
 SoapMessageName
 Specifies the name of the child element of the body of the response message for a web service method. More...
 
 SoapNameSpace
 Overrides the SOAPNAMESPACE class parameter for this web service or web service client. More...
 
 SoapRequestMessage
 This keyword will reflects the expected element name for top element of the SOAP body in the SOAP request. More...
 
 SoapTypeNameSpace
 Overrides the SOAPTYPENAMESPACE class parameter for this web service or web service client. More...
 
 SqlName
 If this method is projected as an SQL stored procedure, then this name is used as the name of the stored procedure. More...
 
 SqlProc
 Specifies that the method can be invoked as an SQL stored procedure. More...
 
 SqlRoutine
 If 'procedure' then this is equivalent to SqlProc keyword and means class method can be called as an SQL procedure. More...
 
 Stub
 Stub. More...
 
 StubMember
 StubMember. More...
 
 TagGenerator
 TagGenerator. More...
 
 UserActualType
 UserActualType. More...
 
 WebMethod
 Specifies that a method can be invoked as a web method using the SOAP protocol. More...
 
 ZenMethod
 Specifies that the method should be projected to the web client for use in the Zen framework. More...
 
 parent
 Pointer to the containing parent object. More...
 

Additional Inherited Members

- Public Member Functions inherited from Persistent
_.Library.Status AcquireLock (_.Library.String locktype)
 Acquires a lock for the current instance. More...
 
_.Library.Status LoadData (_.Library.String id)
 LoadData() - loads an object from storage. More...
 
_.Library.Status OnAfterSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnOpen ()
 This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
 
_.Library.Status OnReload ()
 This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
 
_.Library.Status OnRollBack ()
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status ReleaseLock (_.Library.String locktype)
 Releases a lock for the current instance. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() - saves an object to disk, checks uniqueness and referential More...
 
- Public Member Functions inherited from SwizzleObject
_.Library.Status OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
 This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Member Functions inherited from Persistent
_.Library.Status DeleteData (_.Library.String id, _.Library.Integer concurrency)
 This method is normally generated by the storage class for persistent classes using. More...
 
_.Library.Status KillExtentData (_.Library.Boolean killstreams)
 KillExtentData() - kills extent data in storage. More...
 
_.Library.Status OnAfterBuildIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnAfterDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
_.Library.Status OnAfterPurgeIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnBeforeBuildIndices (_.Library.String indexlist)
 
_.Library.Status OnBeforePurgeIndices (_.Library.String indexlist)
 
_.Library.Status OnDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
- Static Public Attributes inherited from Persistent
 XCOMPACTANCESTRY
 XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
 
 DATALOCATIONGLOBAL = None
 Global name containing master map data for this class. More...
 
 DEFAULTGLOBAL = None
 
 DSCONDITION = None
 DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
 
 DSINTERVAL = None
 DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
 
 DSTIME = None
 If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
 
 EXTENTQUERYSPEC = None
 The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
 
 EXTENTSIZE = None
 The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
 
 GUIDENABLED = None
 If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
 
 IDENTIFIEDBY = None
 The IDENTIFIEDBY parameter can optionally be set to the name. More...
 
 MANAGEDEXTENT = None
 The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
 
 READONLY = None
 READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
 
 ROWLEVELSECURITY = None
 ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
 
 SQLPREVENTFULLSCAN = None
 SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
 
 STORAGEDEFAULT = None
 STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
 
 USEEXTENTSET = None
 
 VERSIONCLIENTNAME = None
 VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
 
 VERSIONPROPERTY = None
 VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
 
- Static Public Attributes inherited from SwizzleObject
 DEFAULTCONCURRENCY = None
 DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
 
 JOURNALSTREAM = None
 If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
 
 OBJJOURNAL = None
 if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Member Data Documentation

◆ Abstract

Abstract

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

ClassMethod

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

ClientMethod

If true this method is only available on the server, and is to be projected as a client method.

 

◆ ClientName

ClientName

An alias used by client projections of this method.

 

◆ CodeMode

CodeMode

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

CompilerGenerated

CompilerGenerated.

 

◆ DefaultArgs

DefaultArgs

DefaultArgs.

 

◆ Deprecated

Deprecated

True if this method is deprecated.

 

◆ Description

Description

Specifies a description of the method.

 

◆ ExternalProcName

ExternalProcName

Specifies the SQL procedure name in the foreign database.

 

◆ Final

Final

Specifies that subclasses cannot override the implementation of the method.

 

◆ ForceGenerate

ForceGenerate

When true we always regenerate this method into each subclass even if normal rules would allow us to call the superclass implementation.

 

◆ FormalSpec

FormalSpec

Specifies the list of arguments.

Each argument is of the format [&|*]<name>[:<type>][=<default>] where & means pass-by-reference and * means output-only.

 

◆ FormalSpecParsed

FormalSpecParsed

FormalSpecParsed.

 

◆ FormalType

FormalType

FormalType.

 

◆ GenerateAfter

GenerateAfter

In the case of a method generator method, specifies that the generator should be invoked after the listed methods are generated.

 

◆ Hash

Hash

Hash.

 

◆ Id

Id

Id.

 

◆ Implementation

Implementation

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

InheritedId

InheritedId.

 

◆ Internal

Internal

If true, then do not display this item in automatic documentation.

 

◆ KeywordError

KeywordError

KeywordError.

 

◆ KeywordModified

KeywordModified

KeywordModified.

 

◆ Label

Label

Label.

 

◆ Language

Language

The language used to implement this method.

 

◆ Name

Name

The name of the method.

 

◆ NoContext

NoContext

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

NotForProperty

Deprecated.

 

◆ NotInheritable

NotInheritable

Specifies that this method is not inherited in subclasses.

 

◆ OptimizedMAC

OptimizedMAC

OptimizedMAC.

 

◆ OptimizedRun

OptimizedRun

OptimizedRun.

 

◆ Origin

Origin

Origin.

 

◆ OriginalName

OriginalName

OriginalName.

 

◆ PlaceAfter

PlaceAfter

Specifies that the class compiler should place this method after the listed methods in the routine it creates for the class.

 

◆ Private

Private

Specifies that the method is private.

Private methods can only be invoked by instance methods of this class or its subclasses.

 

◆ ProcedureBlock

ProcedureBlock

Specifies that this method uses procedure block for method code.

 

◆ PublicList

PublicList

Specifies the public list.

This keyword is used only if the ProcedureBlock keyword is set to true.

 

◆ Requires

Requires

Comma separated string of resource constraints to run this method.

 

◆ ReturnResultsets

ReturnResultsets

If true this method may return zero, one, or more Resultsets in the sqlcontext.

 

◆ ReturnType

ReturnType

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

ReturnTypeParams

A comma separated list of any parameters on the ReturnType keyword.

 

◆ RtnLabel

RtnLabel

RtnLabel.

 

◆ Runnable

Runnable

Runnable.

 

◆ RuntimeClient

RuntimeClient

RuntimeClient.

 

◆ RuntimeCodeMode

RuntimeCodeMode

CodeMode to use for generated methods.

 

◆ RuntimeHash

RuntimeHash

RuntimeHash.

 

◆ RuntimeLanguage

RuntimeLanguage

RuntimeLanguage.

 

◆ SequenceNumber

SequenceNumber

SequenceNumber.

 

◆ ServerOnly

ServerOnly

Specifies that a method will not be projected to a Java or C++ client.

 

◆ SoapAction

SoapAction

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

SoapBindingStyle

Specifies what type of SOAP invocation is used for a web method.

This keyword is ignored for non-web methods.

 

◆ SoapBodyUse

SoapBodyUse

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

SoapMessageName

Specifies the name of the child element of the body of the response message for a web service method.

 

◆ SoapNameSpace

SoapNameSpace

Overrides the SOAPNAMESPACE class parameter for this web service or web service client.

 

◆ SoapRequestMessage

SoapRequestMessage

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

SoapTypeNameSpace

Overrides the SOAPTYPENAMESPACE class parameter for this web service or web service client.

 

◆ SqlName

SqlName

If this method is projected as an SQL stored procedure, then this name is used as the name of the stored procedure.

 

◆ SqlProc

SqlProc

Specifies that the method can be invoked as an SQL stored procedure.

Only class methods can be called as SQL stored procedures.

 

◆ SqlRoutine

SqlRoutine

If &#39;procedure&#39; then this is equivalent to SqlProc keyword and means class method can be called as an SQL procedure.

If &#39;function&#39; then this class method can be called as an SQL function.

 

◆ Stub

Stub

Stub.

 

◆ StubMember

StubMember

StubMember.

 

◆ TagGenerator

TagGenerator

TagGenerator.

 

◆ UserActualType

UserActualType

UserActualType.

 

◆ WebMethod

WebMethod

Specifies that a method can be invoked as a web method using the SOAP protocol.

 

◆ ZenMethod

ZenMethod

Specifies that the method should be projected to the web client for use in the Zen framework.

 

◆ parent

parent

Pointer to the containing parent object.