CompiledProperty Class Reference

Note: The class definition classes in the Library package have been superceded by those in the Dictionary package. More...

Inheritance diagram for CompiledProperty:

Collaboration diagram for CompiledProperty:

Public Member Functions
_.Library.Status	LoadData (_.Library.String propertyId)
	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	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...
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...
Static Public Member Functions inherited from Persistent
_.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
	Calculated
	A flag indicating whether the property is calculated (1) or not (0). More...
	ClassName
	A string containing the name of the class the property belongs to. More...
	Collection
	If the property is a collection, this is a string containing the name of. More...
	Datatype
	More...
	InitialExpression
	A string containing the initial value expression for the property. More...
	MultiDimensional
	A flag indicating whether the property is multi-dimensional (1) or not (0). More...
	Name
	A string containing the name of the property. More...
	Parameters
	An array containing any parameter definitions for the property. More...
	Persistent
	More...
	Private
	A flag indicating whether the property is private (1) or public (0). More...
	Required
	A flag indicating whether the property is required (1) or not (0). More...
	RuntimeDatatype
	More...
	RuntimeType
	More...
	Transient
	A flag indicating whether the property is transient (1) or not (0). More...
	Type
	A string containing the defined type (class name) of the field. 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

Note: The class definition classes in the Library package have been superceded by those in the Dictionary package.

Instead use <class>Dictionary.CompiledProperty</class>.

This class represents a specific property description for a compiled class.

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.

Reimplemented from Persistent.

LoadData()

_.Library.Status LoadData

(

_.Library.String

id

)

LoadData() - loads an object from storage.

This method is

implemented by the storage class.

Reimplemented from Persistent.

SaveData()

_.Library.Status SaveData

(

_.Library.String

id

)

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

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

Reimplemented from Persistent.

Member Data Documentation

Calculated

Calculated

A flag indicating whether the property is calculated (1) or not (0).

 

ClassName

ClassName

A string containing the name of the class the property belongs to.

 

Collection

Collection

If the property is a collection, this is a string containing the name of.

the collection type. If the property is not a collection (single-valued) it contains a null string ("").  

Datatype

Datatype

 

 

InitialExpression

InitialExpression

A string containing the initial value expression for the property.

 

MultiDimensional

MultiDimensional

A flag indicating whether the property is multi-dimensional (1) or not (0).

 

Name

Name

A string containing the name of the property.

 

Parameters

Parameters

An array containing any parameter definitions for the property.

The array

keys are the parameter names and the array values are the parameter values.  

Persistent

Persistent

 

 

Private

Private

A flag indicating whether the property is private (1) or public (0).

 

Required

Required

A flag indicating whether the property is required (1) or not (0).

 

RuntimeDatatype

RuntimeDatatype

 

 

RuntimeType

RuntimeType

 

 

Transient

Transient

A flag indicating whether the property is transient (1) or not (0).

 

Type

Type

A string containing the defined type (class name) of the field.