Max Business Object Array

Returns the business objects that have the maximum value for the specified attribute, as a business object array (BusObjArray object).

Inputs

Business object array
The business object array (specified as a BusObjArray object).

Attribute
A String that specifies the attribute name.

Output

A list of business objects in the form of a BusObjArray object.

Exceptions

The Max Business Object Array function block can throw the following exceptions, both of which are subclassed from CollaborationException :

For each of these exceptions, the Max Business Object Array function block can set the AttributeException exception type.

Notes

The Max Business Object Array function block finds one or more business objects with the maximum value for the specified attribute, and returns these business objects in a BusObjArray object.

For example, suppose that this is a business object array containing Employee business objects and that the input argument is the attribute Salary, a Float. The function block determines the largest value for Salary in all the Employee business objects and returns the business object that contains that value. If multiple business objects have that largest Salary value, the function block returns all of those business objects.

A business object is ignored if the specified attribute contains null. If the value is null in all business objects in the array, null is returned.

When the attribute is of type String, the function block returns the longest string lexically.

Related information

This function block is based on the BusObjArray.maxBusObjArray() method. For more information, see maxBusObjArray().

Copyright IBM Corp. 2004