%Library.PropertyDefinition
persistent class %Library.PropertyDefinition extends %Library.AbstractDefinition
SQL Table Name: %Library.PropertyDefinition
Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package.This class represents a specific property description for a class contained within the Class Dictionary.
Property Inventory (Including Private)
- Calculated
- Cardinality
- ClassName
- Collection
- Deprecated
- Description
- Final
- InitialExpression
- Internal
- Inverse
- MultiDimensional
- Name
- Parameters
- Private
- ReadOnly
- Relationship
- Required
- SequenceNumber
- SqlCollation
- SqlColumnNumber
- SqlComputeCode
- SqlComputeOnChange
- SqlComputed
- SqlFieldName
- SqlListDelimiter
- SqlListType
- Transient
- Type
Method Inventory (Including Private)
Properties
property Calculated as %RawString;
A flag indicating whether the property is calculated (1) or not (0).
Property methods: CalculatedGet(), CalculatedIsValid(), CalculatedSet()
property Cardinality as %RawString;
If the property is a relationship, this is a string contains the cardinality of
the relationship. Cardinality = 'one' indicates the child side of the relationship while
Cardinality = 'many' indicates the parent. Cardinality = 'child' and 'parent' mean the same
but also indicate a dependent relationship.
Property methods: CardinalityGet(), CardinalityIsValid(), CardinalitySet()
property ClassName as %RawString;
A string containing the name of the class the property belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Collection as %RawString;
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 ("").
Property methods: CollectionGet(), CollectionIsValid(), CollectionSet()
property Deprecated as %RawString;
A flag indicating if this property is deprecated (1) or not (0).
Property methods: DeprecatedGet(), DeprecatedIsValid(), DeprecatedSet()
property Description as %RawString;
A string containing the description of the property.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Final as %RawString;
A flag indicating whether the property is final (1) or not (0).
Property methods: FinalGet(), FinalIsValid(), FinalSet()
property InitialExpression as %RawString [ InitialExpression = """""" ];
A string containing the initial value expression for the property.
Property methods: InitialExpressionGet(), InitialExpressionIsValid(), InitialExpressionSet()
property Internal as %RawString;
A flag indicating whether the property is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
property Inverse as %RawString;
A string containing the name of the inverse relationship in the related class.
Property methods: InverseGet(), InverseIsValid(), InverseSet()
property MultiDimensional as %RawString;
A flag indicating whether the property is multi-dimensional (1) or not (0).
Property methods: MultiDimensionalGet(), MultiDimensionalIsValid(), MultiDimensionalSet()
property Name as %RawString;
A string containing the name of the property.
Property methods: NameGet(), NameIsValid(), NameSet()
property Parameters as array of %RawString;
An array containing any parameter definitions for the property. The array
keys are the parameter names and the array values are the parameter values.
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Private as %RawString;
A flag indicating whether the property is private (1) or public (0).
Property methods: PrivateGet(), PrivateIsValid(), PrivateSet()
property ReadOnly as %RawString;
A flag indicating whether the property is a readonly (1) or writeable (0).
Property methods: ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlySet()
property Relationship as %RawString;
A flag indicating whether the property is a relationship (1) or attribute (0).
Property methods: RelationshipGet(), RelationshipIsValid(), RelationshipSet()
property Required as %RawString;
A flag indicating whether the property is required (1) or not (0).
Property methods: RequiredGet(), RequiredIsValid(), RequiredSet()
property SequenceNumber as %RawString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
Property methods: SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberSet()
property SqlCollation as %RawString;
A string containing the name of the class this method belongs to.
Property methods: SqlCollationGet(), SqlCollationIsValid(), SqlCollationSet()
property SqlColumnNumber as %RawString;
The column number used when projecting the property as an SQL table.
Property methods: SqlColumnNumberGet(), SqlColumnNumberIsValid(), SqlColumnNumberSet()
property SqlComputeCode as %RawString;
For an SQL-computed field this is a string containing any SQL compute code for the field.
Property methods: SqlComputeCodeGet(), SqlComputeCodeIsValid(), SqlComputeCodeSet()
property SqlComputeOnChange as %RawString;
Property methods: SqlComputeOnChangeGet(), SqlComputeOnChangeIsValid(), SqlComputeOnChangeSet()
property SqlComputed as %RawString;
A flag indicating whether the property is SQL-computed (1) or not (0).
Property methods: SqlComputedGet(), SqlComputedIsValid(), SqlComputedSet()
property SqlFieldName as %RawString;
A string containing an optional SQL name for the property. This is the name with
which the property is projected to SQL.
Property methods: SqlFieldNameGet(), SqlFieldNameIsValid(), SqlFieldNameSet()
property SqlListDelimiter as %RawString;
Property methods: SqlListDelimiterGet(), SqlListDelimiterIsValid(), SqlListDelimiterSet()
property SqlListType as %RawString;
Property methods: SqlListTypeGet(), SqlListTypeIsValid(), SqlListTypeSet()
property Transient as %RawString;
A flag indicating whether the property is transient (1) or not (0).
Property methods: TransientGet(), TransientIsValid(), TransientSet()
property Type as %RawString;
A string containing the type (class name) of the field.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
Methods
private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]
Inherited description: This method is normally generated by the storage class for persistent classes using
%Storage.Persistent or %Storage.SQL. Persistent
classes using some other storage class, such as %Library.CustomStorage must override this
method.
Inherited description: %LoadData() - loads an object from storage. This method is
implemented by the storage class.
Inherited description: This callback method is invoked by the %New() method to
provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.
private method %OnValidateObject() as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %ValidateObject() method to
provide notification that the current object is being validated.
If this method returns an error then %ValidateObject() will fail.
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential
integrity constraints, and maintains index structures. This method is
implemented by the storage class.
Indices
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods (Including Private)
- %AcquireLock()
- %AddToSaveSet()
- %AddToSyncSet()
- %BuildDeferredIndices()
- %BuildIndices()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %ConstructCloneInit()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnAddToSaveSet()
- %OnAfterBuildIndices()
- %OnAfterDelete()
- %OnAfterPurgeIndices()
- %OnAfterSave()
- %OnBeforeAddToSync()
- %OnBeforeBuildIndices()
- %OnBeforePurgeIndices()
- %OnBeforeSave()
- %OnClose()
- %OnConstructClone()
- %OnDelete()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnJournalObject()
- %OnOpen()
- %OnOpenFinally()
- %OnReload()
- %OnRollBack()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PurgeIndices()
- %ReleaseLock()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- GetTransientState()
- SetTransientState()
- lb()
- li()
- ll()
Storage
Gray indicates storage defined by superclasses.
Storage Model: Storage (%Library.AbstractDefinition)
^%Library.AbstractDefinitionD(ID) |
= | %%CLASSNAME
|