Functional Item Helper Service

Details about the FunctionalItemHelper Service provided by the Functional Items Management Module.

Overview

The FunctionalItemHelper Service (com.prosyst.mbs.services.fim.util.FunctionalItemHelper) is used to simplify the process of getting or setting functional item property values, and for invocation of operations with given arguments. It also provides utility methods for creation of custom types using a set of creation properties, as well as for easy access to the metadata provided by an Item, annotated functional item interfaces and the custom types referenced by their properties and operations.

The TypeConverter interface could be retrieved by the com.prosyst.mbs.services.fim.util.FunctionalItemHelper.getConverter() method.

This is a converter utility that contains helper methods for conversion of FunctionalItem properties and operation parameters.

Converts the value to the correct type, based on the specified metadata, provided in the given TypeMetadata. Some adjustments are done in order to create FIM supported type instances, if their creation data is provided correctly. Used for converting:

• BEAN
• ITEM
• ENUM
• Set, List, Map

It also contains a method for conversion of a JSON Object string representation to an object of a FunctionalItem supported data type.

The TypeUtil class provides common utilities for working with FIM supported data types; the methods:

• deepEquals - compares if two objects of FIM supported data types are equal.
• compareTo - compares two objects of FunctionalItem supported data types for order.
• contains - checks if a collection, array or map has an object added as element.

Registering Bundle

The FIM Core Bundle registers a com.prosyst.mbs.services.fim.util.FunctionalItemHelper service.