Useful properties on class BatchProcessBase

DetailStatus

Returns the detailed status for the batch type. Class BatchProcessBase defines a simple default implementation. Override the default property getter to provide more useful detail information about the status of your batch process for the PolicyCenter Administration screens. The details might be important if your class experiences any error conditions.

For Java implementations, you must implement this property getter as the method getDetailStatus, which takes no arguments.

Exclusive

Sets whether another instance of this batch process can start while the current process is still running. The base class implementation of the isExclusive method always returns true. Override the isExclusive method if you need to customize this behavior. This value does not affect whether other batch process classes can run. It only affects the current batch process class.

For maximum performance, be sure to set the property value to false, if possible. For example, if your batch process takes arguments in its constructor, it might be specific to one entity such as only a single Policy entity. If you want to permit multiple instances of your batch process to run in parallel, you must ensure your batch process class implementation returns false. For example,

override property get Exclusive() : boolean {
  return false
}

For Java implementations, implement this property getter as the method isExclusive, which takes no arguments.

Finished

Returns a Boolean value to indicate whether the process completed. Completion says nothing about the errors, if any.

For Java implementations, implement this property getter as the isFinished method.

OperationsCompleted

Returns a count of how many operations are complete, as an integer value.

For Java implementations, implement this property getter as the getOperationsCompleted method.

OperationsExpected

Returns a count of how many operations PolicyCenter expects the batch process to perform, as an integer value.

For Java implementations, implement this property as the getOperationsExpected method.

OperationsFailed

Returns an internal count for the number of operations that failed.

For Java implementations, implement property getter as the getOperationsFailed method.

Progress

Dynamically returns the progress of the batch process. The base class returns text in the form x of y, with x being the amount of work completed and y being the total amount of work. If the value of y is unknown, the property merely returns x. PolicyCenter determines the values of x and y from the OperationsExpected and OperationsCompleted properties.

For Java implementations, implement the property getter as the getProgress method.

TerminateRequested

Returns a Boolean value that is the return value from the requestTermination method.

Type

Returns the type of the current batch process. There is no need to override the default BatchProcessBase implementation of this property.

For Java implementations, implement the property getter as the getType method, which takes no arguments.