com.sap.portal.obn.analyzer

Interface IOBNAnalyzingBOFilter

All Superinterfaces:

IOBNAnalyzingFilter

public interface IOBNAnalyzingBOFilter
extends IOBNAnalyzingFilter

The interface that defines filtering rules for business objects returned by the OBN analyzer.

IOBNAnalyzingBOFilter automatically creates three sub-filters:

• Any type of business object (system or context) filter
• Context business objects filter
• System business objects filter

Each sub-filter enables you to set filtering rules for the results of that business object type. All three filters are initially set to show all business objects.

When defining rules for only one type, the other type is not filtered at all.

The following code returns a filter that shows all system business objects with system alias: "sys1" or "sys2" and operations: "boot" or "reboot". It also shows all context business objects.

 public IOBNAnalyzingBOFilter Only_System_filtered(IOBNAnalyzingHandler myHandler)
        {
                IOBNAnalyzingBOFilter   myFilter  = myHandler.createOBNAnalyzingBOFilter();
                myFilter.systemBO().system().add("sys1");
                myFilter.systemBO().system().add("sys2");
                myFilter.systemBO().operations().add("boot");
                myFilter.systemBO().operations().add("reboot");

                // myFilter.contextBO().setIgnoreAll(true);  

                return myFilter;
        }
 

There is no filtering definition regarding context business objects and, therefore, no context business objects are filtered out. To filter out all context business objects, you could uncomment the myFilter.contextBO().setIgnoreAll(true); code.

When defining rules for anyTypeBO() filter, each business object is first checked against the filtering rules of anyTypeBO() and, if it hasn't been filtered out, it is checked against the filtering rules of its own type (that is, systemBO or contextBO).

The anyTypeBO() filter provides a shortcut if there is a filtering rule that applies for both context and system objects. For example, instead of writing:

                myFilter.systemBO().operations().add("show");
                myFilter.contextBO().operations().add("show");
 

You can write:

                myFilter.anyTypeBO().operations().add("show");
 

Field Summary

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

FILTER_OUT, MATCH_FILTER, VERIFY

Method Summary

IOBNAnalyzingAnyTypeBOFilter	anyTypeBO() Defines the filtering rules for business objects of all types which are included in the results of the analysis.
IOBNAnalyzingContextBOFilter	contextBO() Defines the filtering rules for context business objects that are included in the results of the analysis.
boolean	isFilterNonExistingBOsAndOps() Whether or not to filter Business Objects and Operations that do not exist.
void	setFilterNonExistingBOsAndOps(boolean filterNonExistingBOsAndOps) Sets the flag that indicates whether or not to omit (filter) the Business Objects and Operations that do not exist.
IOBNAnalyzingSystemBOFilter	systemBO() Defines the filtering rules for system business objects that are included in the results of the analysis.

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

getBOFilterStatus, isBOToFilterOut

Method Detail

anyTypeBO

IOBNAnalyzingAnyTypeBOFilter anyTypeBO()

Defines the filtering rules for business objects of all types which are included in the results of the analysis.

When using the anyTypeBO() filter, each business object is first checked against the filtering rules of anyTypeBO() and, if it hasn't been filtered out, it is checked against the filter of its own type (that is, systemBO or contextBO).

Returns:

a filter for business objects of any type

contextBO

IOBNAnalyzingContextBOFilter contextBO()

Defines the filtering rules for context business objects that are included in the results of the analysis.

Returns:

a filter for business objects of context type

systemBO

IOBNAnalyzingSystemBOFilter systemBO()

Defines the filtering rules for system business objects that are included in the results of the analysis.

Returns:

a filter for business objects of system type

isFilterNonExistingBOsAndOps

boolean isFilterNonExistingBOsAndOps()

Whether or not to filter Business Objects and Operations that do not exist.
For example, suppose an iView is an OBN target for the 'Customer' Business Object with Operation 'Open'. Moreover, suppose that the Business Object was deleted. If the flag is not set (false) then the OBN Analyzer would ignore the iView. If the flag is set (true) then the OBN Analyzer would not ignore the iView. The default value of the flag is true.

Returns:

the flag that indicates whether the filtering of the Business Objects and Operations that do not exist in the PCD is required.

setFilterNonExistingBOsAndOps

void setFilterNonExistingBOsAndOps(boolean filterNonExistingBOsAndOps)

Sets the flag that indicates whether or not to omit (filter) the Business Objects and Operations that do not exist.
For example, assume that there is a need to obtain a list of all the Operations implemented by some iView. Setting the flag to false (the default value is true) and passing the resulting filter to
com.sap.portal.obn.analyzer.IOBNAnalyzingHandler.getAnalyzingContainer(IOBNAnalyzingScope, IOBNAnalyzingBOFilter, IPrincipal)
would cause the com.sap.portal.obn.analyzer.IOBNAnalyzingHandler to bring all the operations defined for the iView with no regards whether the operations exist or not.

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