Ens.Enterprise.MsgBank.ClientUtils
abstract class Ens.Enterprise.MsgBank.ClientUtils extends %Library.RegisteredObject
This class provides utility methods for Message Bank clients.Method Inventory
Methods
classmethod QueueForBanking(Output headersQueued As %Integer, resultSet As %SQL.StatementResult, startId, endId As %String = "", bankedFilter As %Integer = $$$MsgBankFilterAll, bankOverrideFlags As %Integer = 0, iterationLimit As %Integer = 100000, msgBankOperation As %String = $$$MsgBankOperation) as %Status [ SQLProc = ClientUtils_QueueForBanking ]
Projected as the stored procedure: ClientUtils_QueueForBanking
Method used to request headers and optional message bodies and optional search tables
be sent to a Message Bank
The parameters are:
headersQueued - Output parameter that will be set to the number of header based (i.e. header only or header and body with optional searchtable) requests queued for banking.
resultSet - Optional. A result set containing rows of message header IDs to bank. Must contain column named 'ID'.
startId - Required if not specifying resultSet. First Message Header Id to bank.
endId - Optional. Message Header Id ending value. Inclusive. Defaults to empty string which will be taken as the starting Id.
resultSet - Optional. Caller supplied %SQL.StatementResult where column ID exists and is the ID of Message Headers to be queued for banking.
bankedFilter - Optional. Limit banking to only those banked before (value of 1) or those not banked before (value of 2). Defaults to 3 for all.
bankOverrideFlags - Optional. Override of bank flags to use. Combination of required 1 for header plus optional 2 for body and optional 4 for search table if exists.
iterationLimit - Optional. Value to limit quantity of sequential headers that are examined. Defaults to 100,000.
msgBankOperation - Optional. Specify name of banking operation. Defaults to Ens.Enterprise.MsgBankOperation.
Requires privilege %Ens_MsgBank_QueueForBanking:USE
The parameters are:
headersQueued - Output parameter that will be set to the number of header based (i.e. header only or header and body with optional searchtable) requests queued for banking.
resultSet - Optional. A result set containing rows of message header IDs to bank. Must contain column named 'ID'.
startId - Required if not specifying resultSet. First Message Header Id to bank.
endId - Optional. Message Header Id ending value. Inclusive. Defaults to empty string which will be taken as the starting Id.
resultSet - Optional. Caller supplied %SQL.StatementResult where column ID exists and is the ID of Message Headers to be queued for banking.
bankedFilter - Optional. Limit banking to only those banked before (value of 1) or those not banked before (value of 2). Defaults to 3 for all.
bankOverrideFlags - Optional. Override of bank flags to use. Combination of required 1 for header plus optional 2 for body and optional 4 for search table if exists.
iterationLimit - Optional. Value to limit quantity of sequential headers that are examined. Defaults to 100,000.
msgBankOperation - Optional. Specify name of banking operation. Defaults to Ens.Enterprise.MsgBankOperation.
Requires privilege %Ens_MsgBank_QueueForBanking:USE
classmethod QueueForBankingAsync(Output queueToken As %String, startId As %String = "", endId As %String = "", bankedFilter As %Integer = $$$MsgBankFilterAll, bankOverrideFlags As %Integer = 0, iterationLimit As %Integer = 100000, msgBankOperation As %String = $$$MsgBankOperation) as %Status [ SQLProc = ClientUtils_QueueForBankingAsync ]
Projected as the stored procedure: ClientUtils_QueueForBankingAsync
Asynchronous version of QueueForBanking().
Instead of the number of messages queued, the first parameter of this method will be set to the Work Queue token which can later be used to retrieve the results.
This asynchonous version does not support a caller supplied %SQL.StatementResult; therefore, startId is required.
classmethod QueueForBankingFromDynamicObject(config As %DynamicObject) as %DynamicObject
This method is used to invoke QueueForBanking() with a %DynamicObject.
In addition to the parameters for QueueForBanking(), you may set the "async" property to 1 to make use of the asynchronous version.
This method returns a %DynamicObject with properties "sc" and "headersQueued", or "sc" and "queueToken" if called asynchronous.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()