This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%Dictionary.CompiledParameter

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

SQL Table Name: %Dictionary.CompiledParameter

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Abstract as %Boolean;
Abstract
Property methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractSet()
property CompilerGenerated as %Boolean;
CompilerGenerated
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;
Id
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()
property InheritedId as %Boolean;
InheritedId
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;
KeywordError
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
KeywordModified
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;
NotInheritable
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Origin as %CacheString;
Origin
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property SequenceNumber as %Integer;
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property TagGenerator as %CacheString;
TagGenerator
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 ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

classmethod %Exists(oid As %ObjectIdentity) as %Boolean
Inherited description: Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
Inherited description: Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage.
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indexes

index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Triggers

trigger OnDelete (BEFORE event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

Feedback