recurseFilter()

Determines whether the specified attribute value is equal to that of the exclusion or inclusion values.

Syntax

boolean recurseFilter(BusObj busObj,
                String filterAttribute, 
                boolean stopOnFail, 
                String includeValues, 
                String excludeValues)
 

Parameters

busObj
The business object instance on which to filter.

filterAttribute
The name of the business object attribute used when comparing values specified by includeValues and excludeValues. The collaboration compares the value in the filter attribute against the specified inclusion or exclusion values to either prevent or enable synchronization of the business object.

stopOnFail
Specifies how to handle the value of the filterAttribute attribute if it does not meet the filtering criteria.

includesValues
The values the collaboration uses as a filter to allow synchronization of the business object.

excludesValues
The values the collaboration uses as a filter to prevent synchronization of the business object.

Return values

Returns True if filterAttribute contains a value specified in includesValues or a value not specified in excludesValues. Otherwise, the method returns False.

Exceptions

CollaborationException--This exception is thrown if the attribute value of filterAttribute is not specified as an included value but rather as an excluded value and the stopOnFail parameter is set to True.

Copyright IBM Corp. 2003, 2004