Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [MessageHeader]
Private  Storage   

persistent class Ens.MessageHeader extends %Persistent, Ens.MessageHeaderBase, %XML.Adaptor

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 16 8 1


Summary

Properties
Banked BusinessProcessId CorrespondingMessageId Description
ErrorStatus Invocation IsError MessageBodyClassName
MessageBodyId Priority Resent ReturnQueueName
SessionId SourceBusinessType SourceConfigName Status
SuperSession TargetBusinessType TargetConfigName TargetQueueName
TimeCreated TimeProcessed Type

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Exists %ExistsId %Extends
%GUID %GUIDSet %GetLock %GetParameter
%GetSwizzleObject %Id %InsertBatch %IsA
%IsModified %IsNull %KillExtent %KillExtentData
%LoadFromMemory %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnBeforeAddToSync %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject BankedGet MessageId NewErrorResponse
NewRequestMessage NewResponseMessage Purge PurgeBitmaps
PurgeSetTemp ResendDuplicatedMessage ResubmitMessage SetStatus
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
needsReply


Parameters

• parameter EXTENTSIZE = 20000000;
The EXTENTSIZE parameter is used to inform the SQL Query Optimizer of the approximate number of instances in the extent containing instances of this class.

For example, a class that expects to have about 1,000,000 instances should define:

parameter EXTENTSIZE = 1000000;

Properties

• property Banked as %Integer(XMLPROJECTION="NONE") [ Calculated,Transient,ReadOnly ];
Have this header and its MessageBody and SearchTable been archived to the Enterprise Message Bank already? Header=1, Body=2, SearchTable=4, all=7

Methods

• method BankedGet() as %Integer
This is a Get accessor method for the Banked property.
• method MessageId() as %String
The same as %Id(), but works even if the object hasn't been saved already
• method NewErrorResponse(Output pHeader As Ens.MessageHeader, pStatus As %Status) as %Status
creates an error message response header from a request message header
• classmethod NewRequestMessage(ByRef pHeader As Ens.MessageHeader, pMessageBody As %Library.Persistent, ByRef pSessionId As %String, ByRef pSuperSession As %String) as %Status
Create a new request header
• method NewResponseMessage(Output pHeader As Ens.MessageHeader, pMessageBody As %Library.Persistent, pSuperSession As %String = "") as %Status
Create a response message header from a request message header
• classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pKeepIntegrity As %Boolean = 1, pBodiesToo As %Boolean = 0, pBitmapChunkLimit As %Integer = 500) as %Status
• classmethod PurgeSetTemp(pType As %Integer, pMsg As %String, pSC As %Status, pSC2 As %Status) as %Status
Log a warning in the Event Log; add to tSC status; set error/warning in a temp global as below:
Total error count is in subscript 0.
Errors while deleting message headers are in subscript 1.
Errors while deleting message bodies are in subscript 2.
Errors while deleting search table entries are in subscript 3.
• classmethod ResendDuplicatedMessage(pOriginalHeaderId As %String, Output pNewHeaderId As %String, pNewTarget As %String, pNewBody As %RegisteredObject, pNewSource As %String, pHeadOfQueue As %Boolean) as %Status
Resend the message header identified by pOriginalHeaderId by constructing a copy of it and submitting the copy to its target queue. Optional arguments pNewTarget, pNewBody and pNewSource specify replacement values for key header properties. The Description property is updated with an annotation giving the original header ID. Finally the boolean pHeadOfQueue argument specifies whether the new header should be submitted at the end of the target queue or at the head of the line.
• classmethod ResubmitMessage(pHeaderId As %String, pNewTarget As %String, pNewBody As %RegisteredObject, pHeadOfQueue As %Boolean) as %Status
Resubmit the message header identified by pHeaderId to its target queue. Optional arguments pNewTarget and pNewBody specify replacement values for key header properties. If these are given, the Description property is updated with annotations giving the previous values. Finally the boolean pHeadOfQueue argument specifies whether the header should be resubmitted at the end of the target queue or at the head of the line.
• method SetStatus(pStatus As Ens.DataType.MessageStatus)
set and immediately save the status field of this object
• method needsReply() as %Boolean

Indices

•index (Extent on ) [Extent,Type = bitmap];
•index (MessageBodyClassName on MessageBodyClassName) [Type = bitmap];
•index (MessageBodyId on MessageBodyId);
•index (SessionId on SessionId);
•index (SourceConfigName on SourceConfigName) [Type = bitmap];
•index (Status on Status) [Type = bitmap];
•index (TargetConfigName on TargetConfigName) [Type = bitmap];
•index (TimeCreated on TimeCreated);

Triggers

•trigger OnDelete (BEFORE event DELETE)


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.