Overview of Methods

A number of predefined verbs are used for BODs: Sync, Load, Post, Update, Process, and Acknowledge. Depending on the situation, the business object will have to be able to receive such BODs, or send them, or both.

For receiving BODs, a method On<Verb> must be implemented, for example, OnSync, OnProcess, OnAcknowledge. The ‘On’ is added to make clear that the methods are for receiving BODs, not for sending BODs, to avoid a name clash for the existing standard Show method and to avoid confusion with existing specific methods. For sending BODs, the event publishing methods are used.

The business object offers the following methods (or a subset):

  • Methods for receiving requests: OnSync, OnLoad, OnPost, OnUpdate, OnProcess,
  • Methods for receiving replies on sent requests: OnAcknowledge (used after sending a Process request).
  • Method for sending events or request BODs: PublishEvent. This method must be implemented if a Process, Sync, Load, Post or Update event can be published. The ShowAndPublish<Verb>BOD methods (see following section Publishing BODs from the LN Application) are not modeled explicitly, but will automatically available if the PublishEvent is available.
  • For using the ShowAndPublish<Verb>BOD methods, also the Show method must be available.

Each of these methods will be protected. The SubscribeEvent and UnsubscribeEvent methods (as used for BDE event publishing) are not used for BODs.

The business object implementation can make use of (protected) standard methods such as Create, Change and Delete. These can be helpful to easily implement the OnSync, OnLoad, etc. These methods can either be included in the same implementation as protected methods, or they can be implemented in a separate business object.