Home > Class Reference > ENSLIB namespace > %Library.ParameterDefinition

%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 (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

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

Methods (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
private method %OnNew(initvalue As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %OnValidateObject() as %Status
Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.

Inherited Members

Inherited Methods (Including Private)