Class JobProcessMonitor

• Object
  • dw.system.JobProcessMonitor

Reserved for future use.

Properties

totalWork : Number

Reserved for future use. Gets the total work count.

workMessage : String

Reserved for future use. Gets the work message.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getTotalWork() : Number

Reserved for future use.

getWorkMessage() : String

Reserved for future use.

setTotalWork(totalWork : Number) : void

Reserved for future use.

setWorkMessage(msg : String) : void

Reserved for future use.

worked(worked : Number) : void

Reserved for future use.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getTotalWork

getTotalWork() : Number

Reserved for future use. Gets the total work count.

Returns:

the total work count.

getWorkMessage

getWorkMessage() : String

Reserved for future use. Gets the work message.

Returns:

the work message.

setTotalWork

setTotalWork(totalWork : Number) : void

Reserved for future use. Sets the total work count.

Parameters:

totalWork - the total work count.

setWorkMessage

setWorkMessage(msg : String) : void

Reserved for future use. Sets the work message.

Parameters:

msg - the messageto use. If msg is null, then an empty string will be used.

worked

worked(worked : Number) : void

Reserved for future use. Increments the count of work items by the value of the specified parameter.

Parameters:

worked - the number of items worked.