com.sap.portal.obn.service

Interface IOBNService

public interface IOBNService

The interface that enables you to explore OBN data. There are two ways to explore:

• Resolving Container: When you know the business object you want to explore, get a resolving container for the specific business object. The business object is defined in the metadata object passed to the getOBNResolvingContainer(IPrincipal, IOBNMetadata) method.
• Analyzer: When you want to find the related business objects and operations, for example, for a specific user, page or role, get an analyzing handler using the getOBNAnalyzingHandler() method.

Before creating an OBN resolving container, use the OBNFactory to create an IOBNMetadata object with parameters that defines your search. IOBNResolvingContainer IOBNMetadata OBNFactory

Field Summary

static String

KEY The service key.

Method Summary

OBNFactory	getObjectsFactory() Returns an instance of the OBN object factory, which provides methods to create basic OBN-related objects.
IOBNAnalyzingHandler	getOBNAnalyzingHandler() Returns an interface that enables you to perform a search for business objects by the PCD location of the their implementations.
IOBNResolvingContainer	getOBNResolvingContainer(com.sap.security.api.IPrincipal user, IOBNMetadata obnMetadata) Creates an OBN resolving container for the specified OBN metadata and user.
IOBNResolvingContainer	getOBNResolvingContainer(List searchDirCtxs, IOBNMetadata obnMetadata) Creates an OBN resolving container for the specified OBN metadata.

Field Detail

KEY

static final String KEY

The service key.

See Also:

Constant Field Values

Method Detail

getOBNResolvingContainer

IOBNResolvingContainer getOBNResolvingContainer(com.sap.security.api.IPrincipal user,
                                                IOBNMetadata obnMetadata)
                                                throws OBNException

Creates an OBN resolving container for the specified OBN metadata and user.

The resolving process is performed on all of the user assigned roles.

Parameters:

user - the user for whom to perform OBN resolving

obnMetadata - the metadata that defines your search

Returns:

an OBN resolving container that holds your search results

Throws:

OBNException - if an error occurs

getOBNResolvingContainer

IOBNResolvingContainer getOBNResolvingContainer(List searchDirCtxs,
                                                IOBNMetadata obnMetadata)
                                                throws OBNException

Creates an OBN resolving container for the specified OBN metadata. The method enables you to define the OBN search scope to a set of PCD directories.

The resolving process is performed on all the PCD directories that are in the specified list. Each member represents a specific root in the PCD, like a role, a PCD folder or a workset.

Parameters:

searchDirCtxs - a list of DirContext objects that defines the PCD search scope

obnMetadata - the OBN metadata that defines your search

Returns:

an OBN resolving container that holds your search results

Throws:

OBNException - if an error occurs

getObjectsFactory

OBNFactory getObjectsFactory()

Returns an instance of the OBN object factory, which provides methods to create basic OBN-related objects.

This method is equivalent to OBNFactory.getInstance().

Returns:

an OBN object factory instance

getOBNAnalyzingHandler

IOBNAnalyzingHandler getOBNAnalyzingHandler()

Returns an interface that enables you to perform a search for business objects by the PCD location of the their implementations.

Returns:

an interface that enables you to start exploring the OBN data with a specific scope of the PCD (such as a role, folder or page) and get information about the business objects that have implementations in this scope.

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