Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 15 47 1 2


Summary

Properties
Abstract Constraint Default Deprecated Description
Encoded Expression Final Flags Internal
Name SequenceNumber Type parent

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %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
%IsNull %KillExtent %LockExtent %LockId
%New %NormalizeObject %ObjectIsNull %ObjectModified
%Oid %OnBeforeAddToSync %OnDetermineClass %Open
%OpenId %OriginalNamespace %PackageName %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices %ValidateObject
AbstractIsDefined AbstractReset AbstractSet ConstraintIsDefined
ConstraintReset ConstraintSet DefaultIsDefined DefaultReset
DefaultSet DeprecatedIsDefined DeprecatedReset DeprecatedSet
DescriptionIsDefined DescriptionReset DescriptionSet EncodedIsDefined
EncodedReset EncodedSet ExpressionIsDefined ExpressionReset
ExpressionSet FinalIsDefined FinalReset FinalSet
FlagsIsDefined FlagsReset FlagsSet InternalIsDefined
InternalReset InternalSet NameIsDefined NameReset
NameSet SequenceNumberIsDefined SequenceNumberReset SequenceNumberSet
SummaryClose SummaryExecute SummaryFetch TypeIsDefined
TypeReset TypeSet parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Abstract as %Boolean [ InitialExpression = 0 ];
Abstract
• 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 Default as %RawString [ SqlFieldName = _Default ];
Specifies a default value for the parameter assuming the Expression keyword is blank.
• property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this parameter is deprecated.
• property Description as %RawString;
Specifies a description of the parameter.
• property Encoded as %Boolean [ InitialExpression = 0 ];
If true then the parameter value is base64 encoded.
• property Expression as %RawString;
An expression to seed parameter with evaluated at compile time, if specified this takes precedence over the Default keyword.
• property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the parameter.
• property Flags as %RawString;
Specifies any additional modifier flags for the parameter type.
• property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property Name as %Dictionary.Identifier [ Required ];
The name of the parameter.
• property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• property Type as %RawString;
Specifies a type for the parameter. The type is used by Studio to provide input validation for the parameter.
• relationship parent as %Dictionary.ClassDefinition [ 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, timeout As %Integer) as %Status
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
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
• method AbstractReset()
• method AbstractSet(value As %String = "") as %Status
This is a Set accessor method for the Abstract property.
• method ConstraintIsDefined() as %Boolean
• method ConstraintReset()
• method ConstraintSet(value As %String = "") as %Status
This is a Set accessor method for the Constraint property.
• method DefaultIsDefined() as %Boolean
• method DefaultReset()
• method DefaultSet(value As %String = "") as %Status
This is a Set accessor method for the Default property.
• method DeprecatedIsDefined() as %Boolean
• method DeprecatedReset()
• method DeprecatedSet(value As %String = "") as %Status
This is a Set accessor method for the Deprecated property.
• method DescriptionIsDefined() as %Boolean
• method DescriptionReset()
• method DescriptionSet(value As %String = "") as %Status
This is a Set accessor method for the Description property.
• method EncodedIsDefined() as %Boolean
• method EncodedReset()
• method EncodedSet(value As %String = "") as %Status
This is a Set accessor method for the Encoded property.
• method ExpressionIsDefined() as %Boolean
• method ExpressionReset()
• method ExpressionSet(value As %String = "") as %Status
This is a Set accessor method for the Expression property.
• method FinalIsDefined() as %Boolean
• method FinalReset()
• method FinalSet(value As %String = "") as %Status
This is a Set accessor method for the Final property.
• method FlagsIsDefined() as %Boolean
• method FlagsReset()
• method FlagsSet(value As %String = "") as %Status
This is a Set accessor method for the Flags property.
• method InternalIsDefined() as %Boolean
• method InternalReset()
• method InternalSet(value As %String = "") as %Status
This is a Set accessor method for the Internal property.
• method NameIsDefined() as %Boolean
• method NameReset()
• method NameSet(value As %String = "") as %Status
This is a Set accessor method for the Name property.
• method SequenceNumberIsDefined() as %Boolean
• method SequenceNumberReset()
• method SequenceNumberSet(value As %String = "") as %Status
This is a Set accessor method for the SequenceNumber property.
• method TypeIsDefined() as %Boolean
• method TypeReset()
• method TypeSet(value As %String = "") as %Status
This is a Set accessor method for the Type property.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

•index (IDKEY on Name) [IdKey];

Triggers

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


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.