Business Component GetMessages method

Official Content
This documentation is valid for:

This method can be applied to a variable based on a business component type of a Transaction, after executing the Save, Check, Load or Delete methods, in order to get the collection of errors that occurred (those automatically checked by GeneXus as well as the Msg and Error rules defined in the Transaction).

Syntax

&messages=&VbleBasedOnBCType.GetMessages()

Where:

&messages
     Is a -temporary and local- variable defined in a GeneXus object, based on the structured data type named Messages which is automatically defined by GeneXus in every KB:

     MessagesSDTImage

  

&VbleBasedOnBCType
      Is a -temporary and local- variable defined in a GeneXus object, based on a Business Component type of a Transaction.

Example

Suppose you define the following Transaction as Business Component (by setting its Business Component property = True):

Customer
{
  CustomerId*     (Autonumber property = True)
  CustomerName
  CustomerAddress
  CustomerPhone
  CustomerEmail
  CustomerAddedDate
  CustomerTotalMiles
}

Customer rules:

Default(CustomerAddedDate,&today);
Error('The customer can't be deleted because he has miles to use') if delete and CustomerTotalMiles>0;

Accordingly, a Business Component data type of the Customer Transaction is automatically created in the KB and you are able to define in any object, a variable of the new type created. Thus, in a certain object you define a variable named &customer based on the Customer type.

In the same object, indicate also the following two variables:

&Messages: of the Messages data type, collection
&oneMessage: of the Messages.Message data type, which is 1 element in the collection

Then specify the following code in the object (for example if the object is a Procedure, define this code in its source):

&Customer.Load(18)
&Customer.Delete()
if &Customer.success()
   commit
else
   &Messages = &customer.GetMessages()
   for &oneMessage in &Messages
       msg(&oneMessage.Description)
   endfor   
endif

 

See also

Error handling in Business Components
Business Components Methods