Skip to main content

%iKnow.Objects.BlackList

SQL Table Name: %iKnow_Objects.BlackList

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 blacklists.

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.Utils.MaintenanceAPI and other query classes to consult blacklist data 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 BlackListId as %Integer [ Required ];
Property methods: BlackListIdDisplayToLogical(), BlackListIdGet(), BlackListIdIsValid(), BlackListIdLogicalToDisplay(), BlackListIdNormalize(), BlackListIdSet()
property Description as %String);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property ManagerClass as %String (MAXLEN = 256);
Property methods: ManagerClassDisplayToLogical(), ManagerClassGet(), ManagerClassIsValid(), ManagerClassLogicalToDisplay(), ManagerClassLogicalToOdbc(), ManagerClassNormalize(), ManagerClassSet()
property Name as %String;
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

Indexes

index (PKINDEX on DomainId,BlackListId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: SQLStorage

Maps: 1

  • Map number 1 is named MainMap

    thismap.Global: ^IRIS.IK.BlackListId

  • ^IRIS.IK.BlackListId({DomainId},{BlackListId})
    =
    Node Delimiter Piece Name
    1 Name
    2 Description
    3 ManagerClass
FeedbackOpens in a new tab