Home > Class Reference > %SYS namespace > %iKnow.Objects.MetadataField

%iKnow.Objects.MetadataField

persistent class %iKnow.Objects.MetadataField extends %Library.Persistent

SQL Table Name: %iKnow_Objects.MetadataField

Note: the use of this class is no longer recommended for accessing elements of a specific domain. For those scenarios, %iKnow.Tables.Utils offers a more flexible and customizable way of projecting iKnow domain data to SQL

This is a read-only object representation wrapping the internal iKnow data structures for Metadata fields.

This class can be used from ObjectScript or SQL to access a single or small number of entries, but the storage mappings are not meant to support elaborate or complex queries targeting this SQL table.

Please use the predefined queries in %iKnow.Queries.MetadataAPI and other query classes to consult metadata as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

Property Inventory

Parameters

parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

property DataType as %String;
Property methods: DataTypeDisplayToLogical(), DataTypeGet(), DataTypeIsValid(), DataTypeLogicalToDisplay(), DataTypeLogicalToOdbc(), DataTypeNormalize(), DataTypeSet()
property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property FieldId as %Integer [ Required ];
Property methods: FieldIdDisplayToLogical(), FieldIdGet(), FieldIdIsValid(), FieldIdLogicalToDisplay(), FieldIdNormalize(), FieldIdSet()
property HasBitstringStorage as %Boolean [ Calculated ];
Property methods: HasBitstringStorageCompute(), HasBitstringStorageDisplayToLogical(), HasBitstringStorageGet(), HasBitstringStorageIsValid(), HasBitstringStorageLogicalToDisplay(), HasBitstringStorageNormalize(), HasBitstringStorageSQLCompute()
property Hidden as %Boolean;
Property methods: HiddenDisplayToLogical(), HiddenGet(), HiddenIsValid(), HiddenLogicalToDisplay(), HiddenNormalize(), HiddenSet()
property IsCaseSensitive as %Boolean;
Property methods: IsCaseSensitiveDisplayToLogical(), IsCaseSensitiveGet(), IsCaseSensitiveIsValid(), IsCaseSensitiveLogicalToDisplay(), IsCaseSensitiveNormalize(), IsCaseSensitiveSet()
property ListOfValuesId as %Integer;
Property methods: ListOfValuesIdDisplayToLogical(), ListOfValuesIdGet(), ListOfValuesIdIsValid(), ListOfValuesIdLogicalToDisplay(), ListOfValuesIdNormalize(), ListOfValuesIdSet()
property Name as %String (MAXLEN = 1000);
Property methods: NameDisplayToLogical(), NameGet(), NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property StorageType as %Integer;
Property methods: StorageTypeDisplayToLogical(), StorageTypeGet(), StorageTypeIsValid(), StorageTypeLogicalToDisplay(), StorageTypeNormalize(), StorageTypeSet()
property SupportedOperators as %String [ Calculated ];
Property methods: SupportedOperatorsCompute(), SupportedOperatorsDisplayToLogical(), SupportedOperatorsGet(), SupportedOperatorsIsValid(), SupportedOperatorsLogicalToDisplay(), SupportedOperatorsLogicalToOdbc(), SupportedOperatorsNormalize(), SupportedOperatorsSQLCompute()
property ValidateListOfValues as %Boolean;
Property methods: ValidateListOfValuesDisplayToLogical(), ValidateListOfValuesGet(), ValidateListOfValuesIsValid(), ValidateListOfValuesLogicalToDisplay(), ValidateListOfValuesNormalize(), ValidateListOfValuesSet()

Indexes

index (NameIndex on DomainId,Name) [Unique];
Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()
index (PKINDEX on DomainId,FieldId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: SQLStorage

Maps: 2

FeedbackOpens in a new window