BBjNamespace::setCallbackForNamespace

Description

In BBj 3.01 and higher, this method sets a callback that will be called whenever any Named/Variable within this BBjNamespace is set.

Syntax

Return Value	Method
void	setCallbackForNamespace(String `callbackName`)
void	setCallbackForNamespace(CustomObject `customObj`, String `methodName`)
void	setCallbackForNamespace(Object `object`, String `methodName`)

Parameters

Parameter	Description
callbackName	Specifies the name of the callback to be called when the value is set.
customObj	Specifies a UserObject that has a method which is to be called when value is set.
methodName	Specifies the method of userObj which is to be called.
object	Specifies an object that has a method which is to be called when the value is set.

Return Value

None.

Remarks

The callback set using setCallbackForNamespace will be called whenever the value for a variable within the BBjNamespace is set even if the new value is the same as the previous value. This is different from a callback set using the setCallbackForNamespaceChange(), which is only called if the new value is different from the old value.

All callbacks that a program registered on a BBjNamespace are removed when that program executes START, STOP, END, or BEGIN. All callbacks registered by a BBj process are removed when the BBj process terminates.

Version History

Example

namespace! = BBjAPI().getNamespace("test","test",1)

rem 'set a callback that will be called if *any* value in namespace changes
namespace!.setCallbackForNamespaceChange("someValueChanged")

rem 'set a callback that will be called if the value changes
namespace!.setCallbackForVariableChange("x","xChanged")

rem 'set a callback that will be called if *any* value is
rem 'set (even if the value is not changed)
namespace!.setCallbackForNamespace("someValueSet")

rem 'set a callback that will be called if the value of x is set
rem '(even if the values is not changed)
namespace!.setCallbackForVariable("x","xSet")

rem 'remove all callbacks
namespace!.removeCallbackForNamespace()
namespace!.removeCallbackForNamespaceChange()
namespace!.removeCallbackForVariableChange("x")
namespace!.removeCallbackForVariable("x")
end

someValueChanged:
    print "some value in ", namespace!.getName(), " has changed"
return

someValueSet:
    print "some value in ", namespace!.getName(), " has been set"
return

xChanged:
    print "the value of x in ", namespace!.getName(), " has changed"
return

xSet:
    print "the value of x in ", namespace!.getName(), " has been set"
return