Interface BusinessObjectModel
public interface BusinessObjectModel
Represents the definition of a business object in the context of
a data model.
- Since:
- 6.1.1
-
Method Summary
Modifier and TypeMethodDescriptionReturns the localized description of this business object model.getLabel()
Returns the localized label of this business object model.Returns the relationships defined in the business object model's main table.getName()
Returns the name of this business object model.Retrieves the relationships defined in this business object model.Returns the main table of this business object model.initForRead
(Adaptation aRecord, Session aSessionOrNull) Creates a read only facade from the specified record of the main table of this business object model.
-
Method Details
-
getName
String getName()Returns the name of this business object model. This name is unique in the context of the associated data model. This method never returnsnull
. -
getTableNode
SchemaNode getTableNode()Returns the main table of this business object model. This method never returnsnull
. -
getStrongRelationshipsChildren
List<BusinessObjectModelRelationship> getStrongRelationshipsChildren()Retrieves the relationships defined in this business object model. These are considered 'strong' relationships. This implies a tight bond in the lifecycle of related records. This means that changes to one record can cascade to the records linked by this strong relationship. -
getLightRelationshipsChildren
List<BusinessObjectModelRelationship> getLightRelationshipsChildren()Returns the relationships defined in the business object model's main table. These are considered 'light' relationships that are not explicitly defined in the business object model. Light relationships link associated tables that do not define the business object model's structure. -
getLabel
UserMessage getLabel()Returns the localized label of this business object model.- Returns:
null
if no localized label is defined in the data model.
-
getDescription
UserMessage getDescription()Returns the localized description of this business object model.- Returns:
null
if no localized description is defined in the data model.
-
initForRead
Creates a read only facade from the specified record of the main table of this business object model.- Throws:
IllegalArgumentException
- if the specified record isnull
.IllegalArgumentException
- if the specified record is does not belong to the main table of this business object model.- See Also:
-