%Dictionary.ParameterDefinition
persistent class %Dictionary.ParameterDefinition extends %Library.Persistent, %Dictionary.ParameterDefinitionQuery
SQL Table Name: %Dictionary.ParameterDefinition
Property Inventory
- Abstract
- Constraint
- Default
- Deprecated
- Description
- Encoded
- Expression
- Final
- Flags
- Internal
- Name
- SequenceNumber
- Type
- parent
Method Inventory
- %Exists()
- %LockId()
- %UnlockId()
- 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()
- TypeIsDefined()
- TypeReset()
- TypeSet()
- parentOnDelete()
Parameters
parameter SQLENABLED = 1;
Properties
property Abstract as %Boolean [ InitialExpression = 0 ];
Specifies whether this is an abstract parameter.
Property methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize()
property Constraint as %RawString [ SqlFieldName = _Constraint ];
Specifies a constraint value used by Studio to provide input validation for the parameter. Its value is not used nor enforced by the Class Compiler.
Property methods: ConstraintGet(), ConstraintIsValid()
property Default as %RawString [ SqlFieldName = _Default ];
Specifies a default value for the parameter assuming the Expression keyword is blank.
Property methods: DefaultGet(), DefaultIsValid()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this parameter is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize()
property Description as %RawString;
Specifies a description of the parameter.
Property methods: DescriptionGet(), DescriptionIsValid()
property Encoded as %Boolean [ InitialExpression = 0 ];
If true then the parameter value is base64 encoded.
Property methods: EncodedDisplayToLogical(), EncodedGet(), EncodedIsValid(), EncodedLogicalToDisplay(), EncodedNormalize()
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(), ExpressionIsValid()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the parameter.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize()
property Flags as %RawString;
Specifies any additional modifier flags for the parameter type.
Property methods: FlagsGet(), FlagsIsValid()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize()
property Name as %Dictionary.Identifier [ Required ];
The name of the parameter.
Property methods: NameGet(), NameIsValid()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize()
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(), TypeIsValid()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = Parameters , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()
Methods
classmethod %Exists(oid As %ObjectIdentity) as %Boolean
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.
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.
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
method AbstractReset()
method ConstraintIsDefined() as %Boolean
method ConstraintReset()
method DefaultIsDefined() as %Boolean
method DefaultReset()
method DeprecatedIsDefined() as %Boolean
method DeprecatedReset()
method DescriptionIsDefined() as %Boolean
method DescriptionReset()
method EncodedIsDefined() as %Boolean
method EncodedReset()
method ExpressionIsDefined() as %Boolean
method ExpressionReset()
method FinalIsDefined() as %Boolean
method FinalReset()
method FlagsIsDefined() as %Boolean
method FlagsReset()
method InternalIsDefined() as %Boolean
method InternalReset()
method NameIsDefined() as %Boolean
method NameReset()
method SequenceNumberIsDefined() as %Boolean
method SequenceNumberReset()
method TypeIsDefined() as %Boolean
method TypeReset()
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
- %AddToSaveSet()
- %AddToSyncSet()
- %BuildDeferredIndices()
- %BuildIndices()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LockExtent()
- %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()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- SummaryClose()
- SummaryExecute()
- SummaryFetch()