Class %Dictionary.CompiledParameter

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

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	19	7		1		2

Summary

Properties
Abstract	CompilerGenerated	Constraint	Default
Description	Expression	Final	Flags
Id	InheritedId	Internal	KeywordError
KeywordModified	Name	NotInheritable	Origin
SequenceNumber	Type	parent

Methods
%%OIDGet	%AddToSaveSet	%AddToSyncSet	%BuildIndices
%CheckUnique	%ClassIsLatestVersion	%ClassName	%ComposeOid
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GUID	%GUIDSet
%GetLock	%GetParameter	%GetSwizzleObject	%Id
%IsA	%IsModified	%KillExtent	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDetermineClass	%Open
%OpenId	%OriginalNamespace	%PackageName	%PurgeIndices
%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack
%Save	%SaveDirect	%SerializeObject	%SetModified
%SortBegin	%SortEnd	%SyncObjectIn	%SyncTransport
%UnlockExtent	%UnlockId	%ValidateObject	SummaryClose
SummaryExecute	SummaryFetch

Parameters

• parameter SQLENABLED = 1;

Properties

• property Abstract as %Boolean;

Abstract

• property CompilerGenerated as %Boolean;

CompilerGenerated

• 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 Default as %CacheString [ SqlFieldName = _Default ];

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

• property Description as %CacheString;

Specifies a description of the parameter.

• property Expression as %CacheString;

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

• property Final as %Boolean;

Specifies that subclasses cannot override the definition of the parameter.

• property Flags as %CacheString;

Specifies any additional modifier flags for the parameter type.

• property Id as %Integer;

Id

• property InheritedId as %Boolean;

InheritedId

• property Internal as %Boolean;

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

• property KeywordError as %Boolean;

KeywordError

• property KeywordModified as %Boolean;

KeywordModified

• property Name as %Dictionary.CacheIdentifier;

The name of the parameter.

• property NotInheritable as %Boolean;

NotInheritable

• property Origin as %CacheString;

Origin

• property SequenceNumber as %Integer;

SequenceNumber

• property Type as %CacheString;

Specifies a type for the parameter. The type is used by Cache Studio to provide input validation for the parameter. It is not used by the class compiler.

• relationship parent as %Dictionary.CompiledClass [ Inverse = Parameters,Cardinality = parent ];

Pointer to the containing parent object

Methods

• classmethod %Exists(oid As %ObjectIdentity) as %Boolean

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) as %Status

%LockId() 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

%UnlockId() 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.

Indices

• index (IDKEY on Name) [IdKey];

Triggers

• trigger OnDelete (BEFORE event DELETE)

• trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


[BASEXML] > [%Dictionary] > [CompiledParameter]		Private Storage