@BusinessName

You use the @BusinessName annotation to provide a name for a class, a member, or a parameter in the BOM.

Purpose

Provides a name for a class, a member, or a parameter in the BOM.

Syntax

@BusinessName(<a string>)

Description

In Java™, the parameter names are not stored in the class. You can set the @BusinessName annotation to give a business name to a parameter. The parameter names are stored in the BOM, and they are used in the BOM to XOM mapping and in the testing and simulation constructor for testing.

A discrepancy between a BOM name and a XOM name can cause an error. To resolve the error, you must edit the BOM to XOM mapping.

Example

In the XOM, the annotation can be used as follows:

public class Customer {
  public Customer(@BusinessName("name") String name) {...}
  public String getName() {...}
}

The result in the BOM is the following code:

class Customer {
  Customer(string name);
  readonly string name;
}