com.sap.portal.obn.analyzer

Interface IOBNAnalyzingHandler

public interface IOBNAnalyzingHandler

The interface that offers a set of methods to create basic objects of OBN Analyzer. The objects are passed as input parameters to the getAnalyzingContainer method.

This is the starting point of the OBN Analyzer.

To get an instance of this interface, use getOBNAnalyzingHandler.

Method Summary

Modifier and Type	Method and Description
IOBNAnalyzingScope	createOBNAnalysingScope() Creates a new OBN analyzing scope object that defines the PCD locations (such as roles, folders, worksets and pages) of the implementations you want to explore.
IOBNAnalyzingBOFilter	createOBNAnalyzingBOFilter() Creates a new OBN analyzing filter object that filters the business objects that are retrieved.
IOBNAnalyzingContainer	getAnalyzingContainer(IOBNAnalyzingScope scope, IOBNAnalyzingBOFilter filter, com.sap.security.api.IPrincipal user) Returns an interface that enables you to explore the business objects that are retrieved from the OBN analysis.

Method Detail

createOBNAnalysingScope

IOBNAnalyzingScope createOBNAnalysingScope()

Creates a new OBN analyzing scope object that defines the PCD locations (such as roles, folders, worksets and pages) of the implementations you want to explore.

Returns:

a new OBN analyzing scope

createOBNAnalyzingBOFilter

IOBNAnalyzingBOFilter createOBNAnalyzingBOFilter()

Creates a new OBN analyzing filter object that filters the business objects that are retrieved.

Returns:

a new OBN analyzing filter

getAnalyzingContainer

IOBNAnalyzingContainer getAnalyzingContainer(IOBNAnalyzingScope scope,
                                             IOBNAnalyzingBOFilter filter,
                                             com.sap.security.api.IPrincipal user)

Returns an interface that enables you to explore the business objects that are retrieved from the OBN analysis.

Parameters:

scope - defines the PCD locations in which the search for implementations will be performed

filter - a set of filters for filtering the returned business objects

user - the user for accessing the PCD

Returns:

an interface that holds the results of the search