View Article

Validation:

BeforeWizardStepValidate

• Description: Your app calls this method when the user clicks the Next button on a wizard step. Override this method if you want to do something before validating the Wizard step data based on configured Rules Group/Hard Errors.
• Parameters:
  • utlPageMode aenmPageMode
  • String astrWizardName
  • String astrWizardStepName
  • utlWizardNavigationEventArgs we
• Other notes: This is a wizard form method.

BeforeValidate

• Description: Your app calls this method when the user clicks the Save button and receives utlResponseData from the webserver. When called, this method retrieves the entity from the database and binds the modified values to it. Override this method if you want to load or update values before validating the form’s server errors.
• Parameters:
  • utlPageMode aenmPageMode
• Other notes: This method is part of the Save Data Life Cycle.

ValidateConstraints

• Description: Your app calls this method when the user clicks the Save button. When called, this method determines whether your app can persist data. If there are no server/field errors, your app persists the data. If the default Save method finds any server errors, it ends the life cycle with a message to the user that the data is not saved because of errors. Override this method if you want to load or update values during validating the form’s constraints/hard errors.
• Parameters:
  • utlPageMode aenmPageMode
  • String astrButtonID
• Other notes: This method is part of the Save Data Life Cycle. Previously, it was called ValidateHardErrors.

AfterValidate

• Description: Your app calls this method when the user clicks the Save button. Override this method if you want to load values after validating the form’s server errors.
• Parameters: None.
• Other notes: This method is part of the Save Data Life Cycle.

Persists:

BeforePersistChanges

• Description: Your app calls this method if no server errors are found. Override this method if you want your app to do something before it persists changes.
• Parameters: None.
• Other notes: This method is part of the Save Data Life Cycle.

BeforeDialogPersistChanges

• Description: Your app calls this method if the form has a dialog panel whose Finish button’s “Save on Finish” property is True. Override this method if you want your app to do something before it persists changes upon clicking Finish or Save button.
• Parameters:
  • IebBase aebjParentObject
• Other notes: This is an entity method. In future, you will be able to override this method at the form level with formname.dialogid parameter.

PersistChanges

• Description: This method calls the UpdateDataObject method for each data object associated with the form, which persists data based on the entity state (insert, update, or delete).
• Parameters: None.
• Other notes: This method is part of the Save Data Life Cycle.

AfterPersistChanges

• Description: Your app calls this method when the user clicks the Save button. Override this method if you want your app to do something after it persists changes.
• Parameters: None.
• Other notes: This method is part of the Save Data Life Cycle.

AfterDialogPersistChanges

• Description: Your app calls this method when the user clicks the Finish button in a dialog panel whose Finish button's Save on Finish property is True. When called, it saves the record in the database. Override this method if you want your app to do something after it persists changes.
• Parameters:
  • lebBase aobjParentObject
• Other notes: This method is part of the Save Data Life Cycle.

SoftError:

LoadSoftErrors

• Description: Your app calls this method to load the soft errors present in soft errors table before the user clicks the Save button or when the form loads. Override this method if you want to load values before the data is saved.
• Parameters: None.
• Other notes:
  • This method is part of the Save Data Life Cycle.
  • This method gets called when no XML Load method is configured for opening the form.
  • This method only loads the soft errors present in Error table and does not validate errors.

AfterValidateSoftErrors

• Description: Your app calls this method after validating the soft errors when the user clicks the Save button. Override this method if you want to use the soft error object from the method parameter to add the necessary logic at the time of saving the record on the form.
• Parameters:
  • entSoftErrors aobjSoftError
• Other notes: This method is part of the Save Data Life Cycle.

Initialize:

InitializeNewChildObject

• Description: Your app calls this method when the user adds a new child to the data table, dialog panel, or child wizard step. Override this method if you want your app to do something when initializing a child object.
• Parameters:
  • lebBase aobjParentObject
• Other notes: This used to be a server method.

OnLoad:

BeforeGetData

• Description: Your app calls this method on the form's main object before loading the data. Override this method if you want your app to do something before loading the data.
• Parameters: None.

AfterGetData

• Description: Your app calls this method after loading the form's data and controls. Override this method if you want your app to do something after loading the data.
• Parameters: None.

LoadOtherObjects

• Description: Your app calls this method to load other objects after loading the entity object. Override this method to load other objects (calculated fields, properties, etc.) when loading the form.
• Parameters: None.
• Other notes: This is an entity method.

Wizard:

ProcessWizardData 

• Description: Your app calls this method when the user clicks the Finish button on a wizard step. Override this method if you want to do something with the results of the wizard.
• Parameters: 
  • utlWizardNavigationEventArgs we
  • String astrWizardName
  • String astrWizardStepName
  • IebBase aobjParent 

• Other notes: This is a wizard form method.

Trigger:

OnTriggerFail

• Description: Your app calls this method when a trigger fails to meet certain conditions. Override this method if you want to apply custom logic for trigger failure handling, logging or rollback mechanisms. 
• Parameters:
  • utlTriggerHistory aobjTriggerHistory
• Other notes: This is an entity method.

OnTriggerActionFail 

• Description: Your app calls this method when execution of an action tied to the trigger event fails. If multiple trigger actions fail, this method is called once for each failure. Override this method if you want to apply custom logic for trigger action failure handling, logging or rollback mechanisms.
• Parameters:
  • utlTriggerHistory aobjTriggerHistory
  • utlTriggerActionHistory aobjTriggerActionHistory
• Other notes: This is an entity method.

Related Articles

Xelence Life Cycle Methods

This post is part of the Entity topic. Click here to open the Entity Overview.

This post is part of the Maintenance Form topic. Click here to open the Maintenance Form Overview.

This post is part of the Wizard Form topic. Click here to open the Wizard Form Overview.

#Entity
#Forms

#Trigger

#Xelence