Interface DataModelBusinessObjectModels
business object models
defined
in a data model.- Since:
- 6.1.1
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturns all the business object models defined in the data model.getBusinessObjectModels
(Adaptation aDataset, Session aSession) Returns all the business object models defined in the data model.getBusinessObjetModelForTable
(SchemaNode aTableNode) Returns the business object model associated to the specified table.getBusinessObjetModelForTable
(SchemaNode aTableNode, Adaptation aDataset, Session aSession) Returns the business object model associated to the specified table.lookupBusinessObjectModel
(String aName) Return the business object model associated to the specified name.lookupBusinessObjectModel
(String aName, Adaptation aDataset, Session aSession) Return the business object model associated to the specified name.
-
Method Details
-
getBusinessObjetModelForTable
BusinessObjectModel getBusinessObjetModelForTable(SchemaNode aTableNode, Adaptation aDataset, Session aSession) Returns the business object model associated to the specified table.Permissions are resolved using this method. As a result, this method returns
null
if the related business object's main table cannot be viewed by the end-user associated with the given session, in the context of the specified dataset. The business object model's relationships are also filtered. This prevents the end-user associated with the given session, in the context of the specified dataset, from viewing related data when they do not have permission to view the related datamodel. SeeSchemaNodeRelationships.getExplicitRelationships()
for more information about the resolution of the permissions.- Throws:
IllegalArgumentException
- if the specifiedSchemaNode
isnull
.IllegalArgumentException
- if the specifiedSchemaNode
is not a table node.IllegalArgumentException
- if the specifiedAdaptation
isnull
.IllegalStateException
- if the specifiedAdaptation
is not a dataset.IllegalStateException
- if the specifiedAdaptation
has a severe error.IllegalStateException
- if the specified dataset is not an instance of the data model containing this node.IllegalArgumentException
- if the specifiedSession
isnull
.
-
getBusinessObjetModelForTable
Returns the business object model associated to the specified table.The method
getBusinessObjetModelForTable(SchemaNode, Adaptation, Session)
can be used if the business object model associated to this table must be filtered according to the permissions defined for a specific end-user, in the context of a dataset which is an instance of the data model containing this node. -
getBusinessObjectModels
Returns all the business object models defined in the data model.Permissions are resolved using this method. As a result, a business object model is not included if its main table cannot be viewed by the end-user associated with the given session, in the context of the specified dataset. The business object model's relationships are also filtered. This prevents the end-user associated with the given session, in the context of the specified dataset, from viewing related data when they do not have permission to view the related datamodel. See
SchemaNodeRelationships.getExplicitRelationships()
for more information about the resolution of the permissions.- Throws:
IllegalArgumentException
- if the specifiedAdaptation
isnull
.IllegalStateException
- if the specifiedAdaptation
is not a dataset.IllegalStateException
- if the specifiedAdaptation
has a severe error.IllegalStateException
- if the specified dataset is not an instance of the data model containing this node.IllegalArgumentException
- if the specifiedSession
isnull
.
-
getBusinessObjectModels
List<BusinessObjectModel> getBusinessObjectModels()Returns all the business object models defined in the data model.The method
getBusinessObjectModels(Adaptation, Session)
can be used if the business object models must be filtered according to the permissions defined for a specific end-user, in the context of a dataset which is an instance of the data model containing this node. -
lookupBusinessObjectModel
Return the business object model associated to the specified name.Permissions are resolved using this method. As a consequence, this method returns
null
if the main table of the related business object model associated cannot be viewed by the end-user associated with the given session and in the context of the specified dataset. The relationships of the business object model are filtered as well. That is, a relationship (including its child relationships) are not visible if the related data model relationship cannot be viewed by the end-user associated with the given session and in the context of the specified dataset. SeeSchemaNodeRelationships.getExplicitRelationships()
for more information about the resolution of the permissions.- Throws:
IllegalArgumentException
- if the specified name isnull
.IllegalArgumentException
- if the specifiedAdaptation
isnull
.IllegalStateException
- if the specifiedAdaptation
is not a dataset.IllegalStateException
- if the specifiedAdaptation
has a severe error.IllegalStateException
- if the specified dataset is not an instance of the data model containing this node.IllegalArgumentException
- if the specifiedSession
isnull
.- See Also:
-
lookupBusinessObjectModel
Return the business object model associated to the specified name.The method
lookupBusinessObjectModel(String, Adaptation, Session)
can be used if the business object models must be filtered according to the permissions defined for a specific end-user, in the context of a dataset which is an instance of the data model containing this node.- Throws:
IllegalArgumentException
- if the specified name isnull
.- See Also:
-