Home > Class Reference > %SYS namespace > %XSQL.System.CacheMessageXRef


SQL Table Name: %XSQL_System.CacheMessageXRef

sys.messagesXref - lookup from one domain to another. sys_message cross reference to look up XSQL messages given a messageId and an errorCode. errorCode from most messages is '0' but for $$$ObjectScriptError and $$$SQLError the errorCode corresponds to the $ZError and SQLCODE values respectively. This class is not intended for use in error reporting. It is simply a way to convert a message from one domain into an equivalent message in another domain.

Property Inventory

Method Inventory


property cacheMessage as %Integer (XMLPROJECTION = "ATTRIBUTE") [ Required ];
Property methods: cacheMessageDisplayToLogical(), cacheMessageGet(), cacheMessageIsValid(), cacheMessageLogicalToDisplay(), cacheMessageNormalize(), cacheMessageSet(), cacheMessageXSDToLogical()
property errorCode as %String (MAXLEN = 255, XMLPROJECTION = "ATTRIBUTE") [ Required ];
Property methods: errorCodeDisplayToLogical(), errorCodeGet(), errorCodeIsValid(), errorCodeLogicalToDisplay(), errorCodeLogicalToOdbc(), errorCodeNormalize(), errorCodeSet()
property messageText as %String (MAXLEN = 200) [ Calculated ];
Property methods: messageTextCompute(), messageTextDisplayToLogical(), messageTextGet(), messageTextIsValid(), messageTextLogicalToDisplay(), messageTextLogicalToOdbc(), messageTextNormalize(), messageTextSQLCompute()
property xsqlDomain as %String (XMLPROJECTION = "ATTRIBUTE") [ Required ];
Property methods: xsqlDomainDisplayToLogical(), xsqlDomainGet(), xsqlDomainIsValid(), xsqlDomainLogicalToDisplay(), xsqlDomainLogicalToOdbc(), xsqlDomainNormalize(), xsqlDomainSet()
property xsqlId as %Integer);
Property methods: xsqlIdDisplayToLogical(), xsqlIdGet(), xsqlIdIsValid(), xsqlIdLogicalToDisplay(), xsqlIdNormalize(), xsqlIdSet(), xsqlIdXSDToLogical()


classmethod %GetMessageText(pCacheMessageId As %Integer, pErrorCode As %String(MAXLEN=255)) as %String [ Language = objectscript ]
classmethod findCache(pDomain As %String, messageId As %Integer) as %String [ Language = objectscript ]
Lookup a messageId and errorCode given a sys_messages id This is used commonly for a RAISEERROR statement
classmethod findXSQL(pDomain As %String, messageId As %Integer, errorCode As %String(MAXLEN=255)="0") as %Integer [ Language = objectscript ]
findXSQL - lookup a XSQL sys_messages id given a messageId and errorCode messageId is the status id and errorCode is the submessage id.
classmethod linkCacheToXSQL(cacheStatus As %Integer, errorCode As %String(MAXLEN=255)="0", pDomain As %String, messageId As %Integer) [ Language = objectscript ]
classmethod linkMessage(pDomain As %String, messageId As %Integer, cacheStatus As %Integer, errorCode As %String(MAXLEN=255)="0") [ Language = objectscript ]
xref - link XSQL message to message object and invert the link not every message link has an inverse because a given message only uses one inverse message but it may be used by many inverse messages.
classmethod linkXSQLToCache(pDomain As %String, messageId As %Integer, cacheStatus As %Integer, errorCode As %String(MAXLEN=255)="0") [ Language = objectscript ]
classmethod unlinkCacheToXSQL(cacheStatus As %Integer, errorCode As %String(MAXLEN=255)="0", pDomain As %String, messageId As %Integer) [ Language = objectscript ]
classmethod unlinkXSQLToCache(pDomain As %String, messageId As %Integer, cacheStatus As %Integer, errorCode As %String(MAXLEN=255)="0") [ Language = objectscript ]


index (IDK on cacheMessage,errorCode,xsqlDomain) [IdKey, Type = key];
Index methods: IDKCheck(), IDKDelete(), IDKExists(), IDKOpen(), IDKSQLCheckUnique(), IDKSQLExists(), IDKSQLFindPKeyByConstraint(), IDKSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: SQLStorage

Maps: 1