Skip to main content

%Dictionary.CompiledParameter

Class %Dictionary.CompiledParameter Extends (%Persistent, %Dictionary.CompiledParameterQuery) [ StorageStrategy = custom, System = 2 ]

Parameters

SQLENABLED

Parameter SQLENABLED = 1;

Properties

parent

Relationship parent As %Dictionary.CompiledClass [ Cardinality = parent, Inverse = Parameters ];

Pointer to the containing parent object

%isDefined

Property %isDefined As %RawString [ MultiDimensional, Private, Transient ];

Stores the DEFINED state of each attribute.

Abstract

Property Abstract As %Boolean;

Specifies whether this is an abstract parameter.

CompilerGenerated

Property CompilerGenerated As %Boolean;

CompilerGenerated

Constraint

Property Constraint As %RawString [ SqlFieldName = _Constraint ];

Specifies a constraint value used by Studio to provide input validation for the parameter. Its value is not used nor enforced by the Class Compiler.

Default

Property Default As %RawString [ SqlFieldName = _Default ];

Specifies a default value for the parameter assuming the Expression keyword is blank.

Deprecated

Property Deprecated As %Boolean;

True if this parameter is deprecated.

Description

Property Description As %RawString;

Specifies a description of the parameter.

Encoded

Property Encoded As %Boolean;

If true then the parameter value is base64 encoded.

Expression

Property Expression As %RawString;

An expression to seed parameter with evaluated at compile time, if specified this takes precedence over the Default keyword.

Final

Property Final As %Boolean;

Specifies that subclasses cannot override the definition of the parameter.

Flags

Property Flags As %RawString;

Specifies any additional modifier flags for the parameter type.

Id

Property Id As %Integer;

Id

InheritedId

Property InheritedId As %Boolean;

InheritedId

Internal

Property Internal As %Boolean;

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

KeywordError

Property KeywordError As %Boolean;

KeywordError

KeywordModified

Property KeywordModified As %Boolean;

KeywordModified

Name

Property Name As %Dictionary.Identifier [ Required ];

The name of the parameter.

NotInheritable

Property NotInheritable As %Boolean;

NotInheritable

Origin

Property Origin As %RawString;

Origin

SequenceNumber

Property SequenceNumber As %Integer;

SequenceNumber

TagGenerator

Property TagGenerator As %RawString;

TagGenerator

Type

Property Type As %RawString;

Specifies a type for the parameter. The type is used by Studio to provide input validation for the parameter.

Triggers

OnInsertUpdate

Trigger OnInsertUpdate [ Event = INSERT/UPDATE ]

OnDelete

Trigger OnDelete [ Event = DELETE ]

Methods

%OnNew

Method %OnNew(name As %String) As %Status [ Private ]

%LockId

ClassMethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) As %Status

%UnlockId

ClassMethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) As %Status

%Exists

ClassMethod %Exists(oid As %ObjectIdentity) As %Boolean

%LoadData

Method %LoadData(id As %String) As %Status [ Private ]

%SaveData

Method %SaveData(id As %String) As %Status [ Private ]

%DeleteData

ClassMethod %DeleteData(id As %String, concurrency As %Integer) As %Status [ Private ]

AbstractSet

Method AbstractSet(value As %String = "") As %Status

AbstractReset

Method AbstractReset()

AbstractIsDefined

Method AbstractIsDefined() As %Boolean

ConstraintSet

Method ConstraintSet(value As %String = "") As %Status

ConstraintReset

Method ConstraintReset()

ConstraintIsDefined

Method ConstraintIsDefined() As %Boolean

DefaultSet

Method DefaultSet(value As %String = "") As %Status

DefaultReset

Method DefaultReset()

DefaultIsDefined

Method DefaultIsDefined() As %Boolean

DeprecatedSet

Method DeprecatedSet(value As %String = "") As %Status

DeprecatedReset

Method DeprecatedReset()

DeprecatedIsDefined

Method DeprecatedIsDefined() As %Boolean

DescriptionSet

Method DescriptionSet(value As %String = "") As %Status

DescriptionReset

Method DescriptionReset()

DescriptionIsDefined

Method DescriptionIsDefined() As %Boolean

EncodedSet

Method EncodedSet(value As %String = "") As %Status

EncodedReset

Method EncodedReset()

EncodedIsDefined

Method EncodedIsDefined() As %Boolean

ExpressionSet

Method ExpressionSet(value As %String = "") As %Status

ExpressionReset

Method ExpressionReset()

ExpressionIsDefined

Method ExpressionIsDefined() As %Boolean

FinalSet

Method FinalSet(value As %String = "") As %Status

FinalReset

Method FinalReset()

FinalIsDefined

Method FinalIsDefined() As %Boolean

FlagsSet

Method FlagsSet(value As %String = "") As %Status

FlagsReset

Method FlagsReset()

FlagsIsDefined

Method FlagsIsDefined() As %Boolean

InternalSet

Method InternalSet(value As %String = "") As %Status

InternalReset

Method InternalReset()

InternalIsDefined

Method InternalIsDefined() As %Boolean

NameSet

Method NameSet(value As %String = "") As %Status

NameReset

Method NameReset()

NameIsDefined

Method NameIsDefined() As %Boolean

SequenceNumberSet

Method SequenceNumberSet(value As %String = "") As %Status

SequenceNumberReset

Method SequenceNumberReset()

SequenceNumberIsDefined

Method SequenceNumberIsDefined() As %Boolean

TypeSet

Method TypeSet(value As %String = "") As %Status

TypeReset

Method TypeReset()

TypeIsDefined

Method TypeIsDefined() As %Boolean

parentOnDelete

ClassMethod parentOnDelete(id As %String, concurrency As %Integer) As %Status