Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

WebsydianExpress - Callback Point


UserValidateBeforeDelete

Type

Site specific callback point implemented by the user maintenance in the WebsydianExpress administration interface.

When is the callback point called

UserValidateBeforeDelete is called after the normal WebsydianExpress validation of the delete user in the administration interface has been performed successfully - and just before the user will be deleted.

Please note that this callback point is not called by the APIServer.User.Delete / APIServer.User.DeleteValidation APIs. It is only an extension of the administration interface.

How does the callback point influence later functionality

If *Returned Status is not set to *Successful by one or more callback functions for this callback point, the user will not be deleted and an error message will be shown on the insert page.

You can specify up to 10 error messages by populating the field ErrorMessage in the local multi-occurrence variable CallbackErrorArray at the same time, you must specify the number of errors returned in the APIFields.NumberOfErrors in the local variable CallbackOutput.

Example of use

If you want to ensure that a user is not deleted if he has registered any orders in an order database, you can perform the check in a callback function for this callback point.

If you find any orders, set *Returned status to *Error to ensure that the user is not deleted. Populate the first occurrence of CallbackErrorArray<ErrorMessage> with a text explaining the reason the user can't be deleted and set CallbackOutput<APIFields.NumberOfErrors> to 1.

Abstract callback function

Inherit from Callback.WebServer.UserValidateBeforeDelete.AbstractCallbackFunction to create a callback function that can be called by this callback point.

CallbackInput

This local variable contains:

This field will be populated automatically by the callback function. Use the value of this field as you would use a normal input field.

CallbackOutput

This local variable contains:

CallbackErrorArray

This multi-occurrence local variable contains:

You must populate the fields in CallbackOutput and CallbackErrorArray before the callback function is terminated.