Click or drag to resize

OptimizedPersistable Methods

The OptimizedPersistable type exposes the following members.

Methods
  NameDescription
Public methodClone
Public methodCompareTo
Compares objects using the object Id
Public methodEquals
Determines whether the specified Object is equal to the current Object. If this object or other object isn't persistent we call Equals(Object)
(Overrides ObjectEquals(Object).)
Public methodFlushTransients
Process data in transient fields (if any), do whatever is required to persist such data if needed. By default does nothing.
Public methodGetDataMembers
Gets a list of the fields meta data objects
Public methodGetFieldValues
Returns a list of field values of this object or returns it as an array (if this is an array)
Public methodGetHashCode
Computes a hash code based on Oid of object. Make sure to persist objects before using GetHashCode() or override GetHashCode()
(Overrides ObjectGetHashCode.)
Public methodGetPage
Get the persistent storage Page of this object
Public methodGetSession
Gets the session of this object or null if this object isn't yet persisted.
Public methodGetTypeVersion
The database engine needs this internally
Public methodGetWrappedObject
Internally used when IOptimizedPersistable is a wrapper for a non IOptimizedPersistable
Public methodInitializeAfterRead
This function is called when an object has been read from disk and all data members (fields) have been loaded. Override this to provide your own initializations of transient data.
Public methodInitializeAfterRecreate
This function is called when an object has been read from disk before all data members (fields) have been fully loaded. Override this to provide your own initializations of transient data.
Public methodStatic memberListToString
This is a support function for the VelocityDbBrowser
Public methodOidOf
Gets the Oid (encoded as an UInt64) of a non OptimizedPersistable object or 0 if the object isn't persistent on the same page as this object.
Public methodOpen(UInt32, Boolean, Boolean)
Opens a persistent object located in the same Database as this object
Public methodOpenT(UInt32, Boolean, Boolean)
Opens a persistent object located in the same Database as this object
Public methodOptimizedPersistableFieldValues
Gets a list of all field values of the current object that are subclasses of OptimizedPersistable
Public methodPersist(SessionBase, IOptimizedPersistable, Boolean, Boolean)
Persists this object.
Public methodPersist(Placement, SessionBase, Boolean, Boolean, QueueIOptimizedPersistable)
Persists this object. Override in your subclasses when you want fields of your class to be persisted in some special way.
Public methodPersistentVersion
Gets the page version of a persistent object
Public methodPersistMyReferences
Persists references from this object
Public methodReadMe
Used by code generator
Public methodStatic memberReadMeUsingSchemaReflection
Used by code generator. By default objects are read and written using persisted schema information and reflection.
Public methodSetPage
Sets the persistent storage Page of this object
Public methodSetTypeVersion
The database engine needs this internally
Public methodShallowCopyTo
Internal use for now
Public methodToString
Displays class name plus object id
(Overrides ObjectToString.)
Public methodUnpersist
Removes an object from the persistent store and makes the object a transient object. It does not automatically make referenced objects unpersisted. Best way to do so is to override this virtual function in your own classes.
Public methodUpdate
Marks an object as being updated so that object will be written at commit transaction. Call before making object changes!
Public methodUpdate(Action)
Marks an object as being updated so that object will be written at commit transaction. Call before making object changes! Add code to update object in Action parameter.
Public methodUpdateNonIndexField
Marks an object as being updated so that object will be written at commit transaction. Call before updating a NON indexed field. Same as Update but avoids deleting object from indices (if any). If updating a field used in any index, call Update instead or you may end up with one or more corrupt indices.
Public methodUpdateTypeVersion
Updates the object and make this object use the latest Type definition for its class. The object now will now adjust for data attribute changes.
Public methodWrite
By calling this you force a persisted (has an Id) object to be written to disk (if updated) and indices (if any) to be updated. Other objects on the same page will also be written.
Public methodWriteMe
Used by code generator.
Public methodStatic memberWriteMeUsingSchemaReflection
Used by code generator. This is the default way of writing objects using schema information and .NET reflection info.
Top
Extension Methods
  NameDescription
Public Extension MethodToStringDetails(SessionBase, Boolean)Overloaded.
Object details as a string
(Defined by Utilities.)
Public Extension MethodToStringDetails(Schema, TypeVersion, Boolean)Overloaded.
Currently only used by Database Manager
(Defined by Utilities.)
Top
See Also