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

Public Member Functions

_.Library.Status LoadData (_.Library.String id)
 LoadData() - loads an object from storage. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() - saves an object to disk, checks uniqueness and referential More...
 
- 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

_.Library.Status DeleteData (_.Library.String id, _.Library.Integer concurrency)
 This method is normally generated by the storage class for persistent classes using. More...
 
_.Library.Boolean GatewayExists (_.Library.String name)
 Check if there exists a Gateway with a given name.
 
- 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...
 

Public Attributes

 AllowedIPAddresses
   More...
 
 ClassPath
   More...
 
 ConnectionTimeout
   More...
 
 DotNetCorePath
   More...
 
 DotNetVersion
   More...
 
 Exec32
   More...
 
 FilePath
   More...
 
 HeartbeatFailureAction
   More...
 
 HeartbeatFailureRetry
   More...
 
 HeartbeatFailureTimeout
   More...
 
 HeartbeatInterval
   More...
 
 InitializationTimeout
   More...
 
 JVMArgs
   More...
 
 JavaHome
   More...
 
 LogFile
   More...
 
 MainClassName
   More...
 
 Name
   More...
 
 Port
   More...
 
 PyOptions
   More...
 
 PythonPath
   More...
 
 PythonSDKVersion
   More...
 
 Resource
 The Resource name that controls access to this gateway. More...
 
 Server
   More...
 
 Type
   More...
 
 UsePassphrase
   More...
 
 passphraseList
   More...
 

Static Private Member Functions

_.Library.Boolean ExistsId (_.Library.String id)
 Checks to see if the object identified by the ID id exists in the extent. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

This class is maintained for backward compatibility only and it is deprecated. All users should convert their use of this class to the $system.external interface as soon as possible.

Object Gateway Server definitions.

Member Function Documentation

◆ DeleteData()

_.Library.Status DeleteData ( _.Library.String  id,
_.Library.Integer  concurrency 
)
static

This method is normally generated by the storage class for persistent classes using.

<class>Storage.Persistent</class> or <class>Storage.SQL</class>. Persistent classes using some other storage class, such as <class>Library.CustomStorage</class> must override this method.

◆ ExistsId()

_.Library.Boolean ExistsId ( _.Library.String  id)
staticprivate

Checks to see if the object identified by the ID id exists in the extent.

<p>Returns <CLASS>%Boolean</CLASS> TRUE is it exists, FALSE if it does not.

◆ LoadData()

LoadData() - loads an object from storage.

This method is

implemented by the storage class.

◆ SaveData()

SaveData() - saves an object to disk, checks uniqueness and referential

integrity constraints, and maintains index structures. This method is implemented by the storage class.

Member Data Documentation

◆ AllowedIPAddresses

AllowedIPAddresses

 

 

◆ ClassPath

ClassPath

 

 

◆ ConnectionTimeout

ConnectionTimeout

 

 

◆ DotNetCorePath

DotNetCorePath

 

 

◆ DotNetVersion

DotNetVersion

 

 

◆ Exec32

Exec32

 

 

◆ FilePath

FilePath

 

 

◆ HeartbeatFailureAction

HeartbeatFailureAction

 

 

◆ HeartbeatFailureRetry

HeartbeatFailureRetry

 

 

◆ HeartbeatFailureTimeout

HeartbeatFailureTimeout

 

 

◆ HeartbeatInterval

HeartbeatInterval

 

 

◆ InitializationTimeout

InitializationTimeout

 

 

◆ JVMArgs

JVMArgs

 

 

◆ JavaHome

JavaHome

 

 

◆ LogFile

LogFile

 

 

◆ MainClassName

MainClassName

 

 

◆ Name

Name

 

 

◆ Port

Port

 

 

◆ PyOptions

PyOptions

 

 

◆ PythonPath

PythonPath

 

 

◆ PythonSDKVersion

PythonSDKVersion

 

 

◆ Resource

Resource

The Resource name that controls access to this gateway.


If no resource is defined, then it is a public gateway which anyone can use.
 

◆ Server

Server

 

 

◆ Type

Type

 

 

◆ UsePassphrase

UsePassphrase

 

 

◆ passphraseList

passphraseList