InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > %Dictionary.ParameterDefinition

%Dictionary.ParameterDefinition

persistent class %Dictionary.ParameterDefinition extends %Library.Persistent, %Dictionary.ParameterDefinitionQuery

SQL Table Name: %Dictionary.ParameterDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Abstract as %Boolean [ InitialExpression = 0 ];
Abstract
Property methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsDefined(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractReset(), AbstractSet()
property Constraint as %RawString [ SqlFieldName = _Constraint ];
Specifies a constraint value is used by Studio to provide input validation for the parameter. Its value is not used nor enforced by the Class Compiler.
Property methods: ConstraintGet(), ConstraintIsDefined(), ConstraintIsValid(), ConstraintReset(), ConstraintSet()
property Default as %RawString [ SqlFieldName = _Default ];
Specifies a default value for the parameter assuming the Expression keyword is blank.
Property methods: DefaultGet(), DefaultIsDefined(), DefaultIsValid(), DefaultReset(), DefaultSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this parameter is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %RawString;
Specifies a description of the parameter.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), DescriptionSet()
property Encoded as %Boolean [ InitialExpression = 0 ];
If true then the parameter value is base64 encoded.
Property methods: EncodedDisplayToLogical(), EncodedGet(), EncodedIsDefined(), EncodedIsValid(), EncodedLogicalToDisplay(), EncodedNormalize(), EncodedReset(), EncodedSet()
property Expression as %RawString;
An expression to seed parameter with evaluated at compile time, if specified this takes precedence over the Default keyword.
Property methods: ExpressionGet(), ExpressionIsDefined(), ExpressionIsValid(), ExpressionReset(), ExpressionSet()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the parameter.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsDefined(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalReset(), FinalSet()
property Flags as %RawString;
Specifies any additional modifier flags for the parameter type.
Property methods: FlagsGet(), FlagsIsDefined(), FlagsIsValid(), FlagsReset(), FlagsSet()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsDefined(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalReset(), InternalSet()
property Name as %Dictionary.Identifier [ Required ];
The name of the parameter.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsDefined(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberReset(), SequenceNumberSet()
property Type as %RawString;
Specifies a type for the parameter. The type is used by Studio to provide input validation for the parameter.
Property methods: TypeGet(), TypeIsDefined(), TypeIsValid(), TypeReset(), TypeSet()
relationship parent as %Dictionary.ClassDefinition [ 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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 %Storage.Persistent or %Storage.SQL.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status [ Language = objectscript ]
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 %Storage.Persistent or %Storage.SQL.
method AbstractIsDefined() as %Boolean [ Language = objectscript ]
method AbstractReset() [ Language = objectscript ]
method AbstractSet(value As %String = "") as %Status [ Language = objectscript ]
method ConstraintIsDefined() as %Boolean [ Language = objectscript ]
method ConstraintReset() [ Language = objectscript ]
method ConstraintSet(value As %String = "") as %Status [ Language = objectscript ]
method DefaultIsDefined() as %Boolean [ Language = objectscript ]
method DefaultReset() [ Language = objectscript ]
method DefaultSet(value As %String = "") as %Status [ Language = objectscript ]
method DeprecatedIsDefined() as %Boolean [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method EncodedIsDefined() as %Boolean [ Language = objectscript ]
method EncodedReset() [ Language = objectscript ]
method EncodedSet(value As %String = "") as %Status [ Language = objectscript ]
method ExpressionIsDefined() as %Boolean [ Language = objectscript ]
method ExpressionReset() [ Language = objectscript ]
method ExpressionSet(value As %String = "") as %Status [ Language = objectscript ]
method FinalIsDefined() as %Boolean [ Language = objectscript ]
method FinalReset() [ Language = objectscript ]
method FinalSet(value As %String = "") as %Status [ Language = objectscript ]
method FlagsIsDefined() as %Boolean [ Language = objectscript ]
method FlagsReset() [ Language = objectscript ]
method FlagsSet(value As %String = "") as %Status [ Language = objectscript ]
method InternalIsDefined() as %Boolean [ Language = objectscript ]
method InternalReset() [ Language = objectscript ]
method InternalSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeIsDefined() as %Boolean [ Language = objectscript ]
method TypeReset() [ Language = objectscript ]
method TypeSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]

Indexes

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

Triggers

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

Inherited Members

Inherited Methods

Feedback