Object aliases

The logicalTypeName() element is used to provide a unique alias for the object’s class name.

This value is used internally to generate a string representation of an objects identity (the Oid). This can appear in several contexts, including:

Examples

For example:

@Named("orders.Order")
@DomainObject
public class Order {
    ...
}

Precedence

The rules of precedence are:

  1. @DomainObject#logicalTypeName

  2. ORM-specific, @Table#schema().

  3. Fully qualified class name of the entity.

This might be obvious, but to make explicit: we recommend that you always specify an object type for your domain objects.

Otherwise, if you refactor your code (change class name or move package), then any externally held references to the OID of the object will break. At best this will require a data migration in the database; at worst it could cause external clients, eg if accessing data through the Restful Objects viewer, to break.

If the object type is not unique across all domain classes then the framework will fail-fast and fail to boot. An error message will be printed in the log to help you determine which classes have duplicate object tyoes.