com.sap.portal.obn.analyzer.filter.bo

Interface IOBNAnalyzingAnyTypeBOFilter

All Superinterfaces:

IOBNAnalyzingFilter

All Known Subinterfaces:

IOBNAnalyzingContextBOFilter, IOBNAnalyzingSystemBOFilter

public interface IOBNAnalyzingAnyTypeBOFilter
extends IOBNAnalyzingFilter

The interface that defines the filtering rules for business objects of all types which are included in the results returned by OBN analysis.

Field Summary

Fields inherited from interface com.sap.portal.obn.analyzer.filter.IOBNAnalyzingFilter

FILTER_OUT, MATCH_FILTER, VERIFY

Method Summary

IOBNAnalyzingStringFilter	id() Returns the business object ID filter, for setting the business object ID property of the filter.
boolean	isIgnoreAll() Indicates whether all business objects of this type are ignored.
IOBNAnalyzingOperationFilter	operations() Returns the operations filter, for setting the operation property of the filter.
void	setIgnoreAll(boolean ignoreAll) Sets a flag for mass exclude for objects of this type.

Methods inherited from interface com.sap.portal.obn.analyzer.filter.IOBNAnalyzingFilter

getBOFilterStatus, isBOToFilterOut

Method Detail

setIgnoreAll

void setIgnoreAll(boolean ignoreAll)

Sets a flag for mass exclude for objects of this type. The default is false.

When true, the business objects of this type are filtered out from the final results. This method is useful when you want to get business objects of only one type.

For example, the following code allows only system business objects to be returned in the results:

                        myFilter.contextBO().setIgnoreAll(true);  
 

WARNING: The following code filters out all business objects!

                        myFilter.anyTypeBO().setIgnoreAll(true);  
 

Parameters:

ignoreAll - if true, ignores all business objects of this type

isIgnoreAll

boolean isIgnoreAll()

Indicates whether all business objects of this type are ignored.

Returns:

true if all business objects of this type are filtered out

operations

IOBNAnalyzingOperationFilter operations()

Returns the operations filter, for setting the operation property of the filter.

Use the returned interface to set filtering rules for business objects based on their operations.

Returns:

operations filter for all objects of this business object type

id

IOBNAnalyzingStringFilter id()

Returns the business object ID filter, for setting the business object ID property of the filter.

Use returned interface to set filtering rules for business objects based on their ID.

Returns:

business object ID filter for all objects of this business object type

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN