com.sap.portal.obn.analyzer

Interface IOBNAnalyzingScope

public interface IOBNAnalyzingScope

The interface that defines the scope of the OBN analysis. A scope is a list of locations in the PCD, such as a role, folder, workset or page.

An IOBNAnalyzingHandler object finds all the business objects that have implementations in the defined scope.

Method Summary

void	addDirContext(DirContext dirContext) Adds a PCD object to the list of PCD objects that define the analysis scope.
void	addDirContextsOfUserRoles(com.sap.security.api.IPrincipal user) Extracts all user-assigned roles from the specified user and adds those roles to the list of PCD objects that define the analysis scope.
void	addURLs(List urls, com.sap.security.api.IPrincipal user) Adds a PCD object to the list of PCD objects that define the analysis scope.
List	getDirContexts() Gets the DirContext objects for the PCD objects that define the analysis scope.
List	getNamespaces() Gets the PCD address (URL) of the PCD objects that define the analysis scope.

Method Detail

getDirContexts

List getDirContexts()

Gets the DirContext objects for the PCD objects that define the analysis scope.

Returns:

a list of DirContext objects for the PCD objects that define the analysis scope

getNamespaces

List getNamespaces()

Gets the PCD address (URL) of the PCD objects that define the analysis scope.

Returns:

a list of Strings that represent the PCD address (URL) of each PCD object that defines the scope

addDirContext

void addDirContext(DirContext dirContext)
                   throws OBNException

Adds a PCD object to the list of PCD objects that define the analysis scope.

Parameters:

dirContext - the DirContext for a PCD object

Throws:

if - the DirContext object is invalid

OBNException

addDirContextsOfUserRoles

void addDirContextsOfUserRoles(com.sap.security.api.IPrincipal user)
                               throws OBNException

Extracts all user-assigned roles from the specified user and adds those roles to the list of PCD objects that define the analysis scope.

Parameters:

user - the user whose roles are extracted

Throws:

OBNException - if an error occurs while extracting the user roles

addURLs

void addURLs(List urls,
             com.sap.security.api.IPrincipal user)
             throws OBNException

Adds a PCD object to the list of PCD objects that define the analysis scope.

Parameters:

urls - a list of String objects, each one a PCD address (URL) to be added to the scope

user - the user to be used to obtain the permissions to create the DirContext object

Throws:

OBNException - if the PCD address (URL) is invalid

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