Home > Class Reference > ENSLIB namespace > %Dictionary.CompiledParameter


persistent class %Dictionary.CompiledParameter extends %Library.Persistent, %Dictionary.CompiledParameterQuery

SQL Table Name: %Dictionary.CompiledParameter

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter SQLENABLED = 1;

Properties (Including Private)

property Abstract as %Boolean;
Property methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractSet()
property CompilerGenerated as %Boolean;
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property Constraint as %CacheString [ SqlFieldName = _Constraint ];
Specifies a constraint value is used by Cache Studio to provide input validation for the parameter. Its value is not used nor enforced by the Class Compiler.
Property methods: ConstraintGet(), ConstraintIsValid(), ConstraintSet()
property Default as %CacheString [ SqlFieldName = _Default ];
Specifies a default value for the parameter assuming the Expression keyword is blank.
Property methods: DefaultGet(), DefaultIsValid(), DefaultSet()
property Deprecated as %Boolean;
True if this parameter is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the parameter.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Encoded as %Boolean;
If true then the parameter value is base64 encoded.
Property methods: EncodedDisplayToLogical(), EncodedGet(), EncodedIsValid(), EncodedLogicalToDisplay(), EncodedNormalize(), EncodedSet()
property Expression as %CacheString;
An expression to seed parameter with evaluated at compile time, if specified this takes precedence over the Default keyword.
Property methods: ExpressionGet(), ExpressionIsValid(), ExpressionSet()
property Final as %Boolean;
Specifies that subclasses cannot override the definition of the parameter.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property Flags as %CacheString;
Specifies any additional modifier flags for the parameter type.
Property methods: FlagsGet(), FlagsIsValid(), FlagsSet()
property Id as %Integer;
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()
property InheritedId as %Boolean;
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property Internal as %Boolean;
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property KeywordError as %Boolean;
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the parameter.
Property methods: NameGet(), NameIsValid(), NameSet()
property NotInheritable as %Boolean;
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Origin as %CacheString;
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property SequenceNumber as %Integer;
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property TagGenerator as %CacheString;
Property methods: TagGeneratorGet(), TagGeneratorIsValid(), TagGeneratorSet()
property Type as %CacheString;
Specifies a type for the parameter. The type is used by Cache Studio to provide input validation for the parameter.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
relationship parent as %Dictionary.CompiledClass [ Required , Inverse = Parameters , Cardinality = parent ];