Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Library] >  [ParameterDefinition]
Private  Storage   

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package. Instead use %Dictionary.ParameterDefinition.

This class represents a specific class parameter description.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
11


Summary

Properties
ClassName Constraint Default Deprecated Description
Final Flags Internal Name SequenceNumber
Type

Methods
%AddToSaveSet %AddToSyncSet %BuildDeferredIndices %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 %OnDeleteFinally
%OnDetermineClass %OnOpenFinally %OnSaveFinally %Open
%OpenId %OriginalNamespace %PackageName %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices %ValidateObject
%ValidateTable GetTransientState SetTransientState lb
li ll


Properties

• property ClassName as %RawString;
A string containing the name of the class the method belongs to.
• property Constraint as %RawString;
This is for internal use only.
• property Default as %RawString;
A string containing the default value for the class parameter.
• property Deprecated as %RawString;
A flag indicating if this parameter is deprecated (1) or not (0).
• property Description as %RawString;
A string containing the description for the class parameter.
• property Final as %RawString;
A flag indicating whether the class parameter is final (1) or not (0).
• property Flags as %RawString;
This is for internal use only.
• property Internal as %RawString;
A flag indicating whether the class parameter is internal (1) or not (0).
• property Name as %RawString;
A string containing the name of the class parameter.
• property SequenceNumber as %RawString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
• property Type as %RawString;
This is for internal use only.


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