Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%Library.ParameterDefinition

persistent class %Library.ParameterDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.ParameterDefinition

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

This class represents a specific class parameter description for a class contained within the Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory

Properties

property ClassName as %CacheString;
A string containing the name of the class the method belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Constraint as %CacheString;
This is for internal use only.
Property methods: ConstraintGet(), ConstraintIsValid(), ConstraintSet()
property Default as %CacheString;
A string containing the default value for the class parameter.
Property methods: DefaultGet(), DefaultIsValid(), DefaultSet()
property Description as %CacheString;
A string containing the description for the class parameter.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Final as %CacheString;
A flag indicating whether the class parameter is final (1) or not (0).
Property methods: FinalGet(), FinalIsValid(), FinalSet()
property Flags as %CacheString;
This is for internal use only.
Property methods: FlagsGet(), FlagsIsValid(), FlagsSet()
property Internal as %CacheString;
A flag indicating whether the class parameter is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
property Name as %CacheString;
A string containing the name of the class parameter.
Property methods: NameGet(), NameIsValid(), NameSet()
property SequenceNumber as %CacheString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
Property methods: SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberSet()
property Type as %CacheString;
This is for internal use only.
Property methods: TypeGet(), TypeIsValid(), TypeSet()

Indexes

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

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (%Library.AbstractDefinition)

^%Library.AbstractDefinitionD(ID)
=
%%CLASSNAME
FeedbackOpens in a new tab