CompiledProperty Class Reference

Inheritance diagram for CompiledProperty:

Collaboration diagram for CompiledProperty:

Public Attributes
	Aliases
	List of aliases for this property. More...
	Calculated
	Specifies that the property has no in-memory storage allocated for it when the object containing it is instantiated. More...
	Cardinality
	Specifies the cardinality of a relationship property. More...
	ClientName
	An alias used by client projections of this property. More...
	Collection
	Specifies that a property is a collection property as well as what type of collection it is. More...
	CompilerGenerated
	CompilerGenerated. More...
	ComputeDependency
	List of properties referenced by the SQLCOMPUTECODE. More...
	ComputeTriggers
	List of properties to be computed when this property changes. More...
	Deprecated
	True if this property is deprecated. More...
	Description
	Specifies a description of the property. More...
	DirectRefOnGet
	Deprecated. More...
	DirectRefOnSet
	Deprecated. More...
	Final
	Specifies that subclasses cannot override the definition of this property. More...
	Id
	Id. More...
	Identity
	Specifies that this property is the identity for this class. More...
	InheritedId
	InheritedId. More...
	InitialExpression
	Specifies an initial value for the property. More...
	Internal
	If true, then do not display this item in automatic documentation. More...
	Inverse
	Specifies the name of the inverse side of a relationship. More...
	KeywordError
	KeywordError. More...
	KeywordModified
	KeywordModified. More...
	Methods
	Method. More...
	MultiDimensional
	Specifies that an attribute has the characteristics of a multidimensional array. More...
	Name
	The name of the property. More...
	NoModBit
	Deprecated. More...
	NotInheritable
	Deprecated. More...
	OnDelete
	Specifies what referential action to take when the key value is deleted from the foreign table. More...
	Origin
	Origin. More...
	Parameters
	Parameter. More...
	Private
	Specifies that the property is private. More...
	ReadOnly
	Specifies that the property is readonly. More...
	Relationship
	Specifies that a property is a relationship property. More...
	Required
	In the case of a persistent class, specifies that the value of the property must be given a value before it can be stored to disk. More...
	RuntimeType
	RuntimeType. More...
	SequenceNumber
	SequenceNumber. More...
	ServerOnly
	Specifies that a property will not be projected to a Java or C++ client. More...
	SqlCollation
	Deprecated. More...
	SqlColumnNumber
	Explicitly sets the SQL Column number for this property. More...
	SqlComputeCode
	Specifies ObjectScript code that evaluates to a computed field value. More...
	SqlComputeOnChange
	Specifies one or more properties whose modification triggers the recalculation of this computed field within SQL. More...
	SqlComputed
	Specifies that this property is an SQL computed field. More...
	SqlFieldName
	In the case of a persistent class, specifies the column name used to identify the property in its SQL projection. More...
	SqlListDelimiter
	Specifies the delimiter character used within SQL for lists. More...
	SqlListType
	specifies the representation to be used for a list. More...
	Storable
	Storable. More...
	Transient
	In the case of a persistent class, specifies that the property is not stored in the database. More...
	Type
	Specifies the name of the class associated with the property, which can be a data type class, a persistent class, or an embeddable serial class. More...
	UDLTexts
	UDLText. 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

Aliases

Aliases

List of aliases for this property.

 

Calculated

Calculated

Specifies that the property has no in-memory storage allocated for it when the object containing it is instantiated.

 

Cardinality

Cardinality

Specifies the cardinality of a relationship property.

The Cardinality keyword is required for relationship properties. It is ignored by non-relationship properties.

 

ClientName

ClientName

An alias used by client projections of this property.

 

Collection

Collection

Specifies that a property is a collection property as well as what type of collection it is.

 

CompilerGenerated

CompilerGenerated

CompilerGenerated.

 

ComputeDependency

ComputeDependency

List of properties referenced by the SQLCOMPUTECODE.

 

ComputeTriggers

ComputeTriggers

List of properties to be computed when this property changes.

 

Deprecated

Deprecated

True if this property is deprecated.

 

Description

Description

Specifies a description of the property.

 

DirectRefOnGet

DirectRefOnGet

Deprecated.

 

DirectRefOnSet

DirectRefOnSet

Deprecated.

 

Final

Final

Specifies that subclasses cannot override the definition of this property.

 

Id

Id

Id.

 

Identity

Identity

Specifies that this property is the identity for this class.

Identity properties can be set in new objects only and the default is set by incrementing a counter.

 

InheritedId

InheritedId

InheritedId.

 

InitialExpression

InitialExpression

Specifies an initial value for the property.

 

Internal

Internal

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

 

Inverse

Inverse

Specifies the name of the inverse side of a relationship.

That is, the name of the corresponding relationship property in the related class. The inverse property must exist in the related class and have the correct Cardinality value. The Inverse keyword is required for relationship properties. It is ignored by non-relationship properties.

 

KeywordError

KeywordError

KeywordError.

 

KeywordModified

KeywordModified

KeywordModified.

 

Methods

Methods

Method.

 

MultiDimensional

MultiDimensional

Specifies that an attribute has the characteristics of a multidimensional array.

 

Name

Name

The name of the property.

 

NoModBit

NoModBit

Deprecated.

 

NotInheritable

NotInheritable

Deprecated.

 

OnDelete

OnDelete

Specifies what referential action to take when the key value is deleted from the foreign table.

 

Origin

Origin

Origin.

 

Parameters

Parameters

Parameter.

 

Private

Private

Specifies that the property is private.

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

 

ReadOnly

ReadOnly

Specifies that the property is readonly.

 

Relationship

Relationship

Specifies that a property is a relationship property.

 

Required

Required

In the case of a persistent class, specifies that the value of the property must be given a value before it can be stored to disk.

 

RuntimeType

RuntimeType

RuntimeType.

 

SequenceNumber

SequenceNumber

SequenceNumber.

 

ServerOnly

ServerOnly

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

 

SqlCollation

SqlCollation

Deprecated.

 

SqlColumnNumber

SqlColumnNumber

Explicitly sets the SQL Column number for this property.

This is provided for legacy application support.

 

SqlComputeCode

SqlComputeCode

Specifies ObjectScript code that evaluates to a computed field value.

 

SqlComputeOnChange

SqlComputeOnChange

Specifies one or more properties whose modification triggers the recalculation of this computed field within SQL.

 

SqlComputed

SqlComputed

Specifies that this property is an SQL computed field.

 

SqlFieldName

SqlFieldName

In the case of a persistent class, specifies the column name used to identify the property in its SQL projection.

By default, the SQL column name is the same as the property name.

 

SqlListDelimiter

SqlListDelimiter

Specifies the delimiter character used within SQL for lists.

This is provided for legacy application support.

 

SqlListType

SqlListType

specifies the representation to be used for a list.

 

Storable

Storable

Storable.

 

Transient

Transient

In the case of a persistent class, specifies that the property is not stored in the database.

 

Type

Type

Specifies the name of the class associated with the property, which can be a data type class, a persistent class, or an embeddable serial class.

 

UDLTexts

UDLTexts

UDLText.

 

parent

parent

Pointer to the containing parent object.