com.sap.portal.unification

Interface IObjectBasedNavigation

Deprecated. since NW7.1. For the new OBN APIs See com.sap.portal.obn.service.

public interface IObjectBasedNavigation

The interface that handles finding navigation targets according to the client action that is performed on a business object.
All the methods get either the full operation name or the business object name. The role service is used to identify the user's role and to find the targets.
An operation object connects between the business object and the relevant navigation targets. An operation object is bound under a business object, while operations are implemented by a target. An example of a navigation target is an iView.
An operation name has the following format:
SystemAlias.BusinessObject.Operation.

The first two parts (SystemAlias.BusinessObject) are the name of the business object under which the operation is bound. The second part is the (Operation) is the operation to perform.

Field Summary

static String

KEY Deprecated.

Method Summary

IOBNTarget	getDefaultTarget(String systemAlias, String businessObjName, IPortalComponentRequest request) Deprecated. Gets the default OBN target that belongs to the specified business object.
IOBNTarget	getDefaultTargetForOperation(String systemAlias, String businessObjName, String operationName, IPortalComponentRequest request) Deprecated. Gets the default OBN target that implements the specified operation that belongs to the specified business object.
List	getTargets(String systemAlias, String businessObjName, IPortalComponentRequest request) Deprecated. Gets a list of target iViews that belong to the specified business object.
Set	getTargetsForOperation(String systemName, String objectName, String operationName, IPortalComponentRequest request) Deprecated. Gets a list of iViews that implement the specified operation.
boolean	isTargetExist(String systemAlias, String objectName, IPortalComponentRequest request) Deprecated. Checks if there is an iView that implements an operation that belongs to the specified business object.
boolean	isTargetExistsForOperation(String systemAlias, String objectName, String operationName, IPortalComponentRequest request) Deprecated. Checks if there is an iView that implements the specified operation.

Field Detail

KEY

static final String KEY

Deprecated.

See Also:

Constant Field Values

Method Detail

getDefaultTarget

IOBNTarget getDefaultTarget(String systemAlias,
                            String businessObjName,
                            IPortalComponentRequest request)

Deprecated.

Gets the default OBN target that belongs to the specified business object. An OBN target is a single pair of iView, Operation.
The returned pair must fulfill the following conditions:

• The operation object belongs to the specified business object.
• The operation is implemented by the iView.
• The operation has the highest priority of all other pairs.

Parameters:

systemAlias - a system alias

businessObjName - a business object

request - a portal component request

Returns:

the OBN target

getTargets

List getTargets(String systemAlias,
                String businessObjName,
                IPortalComponentRequest request)

Deprecated.

Gets a list of target iViews that belong to the specified business object.
Each iView in the result list must fulfill the following conditions:

• The operation object belongs to the specified business object.
• The operation object is implemented by the iView.

Parameters:

systemAlias - a system alias

businessObjName - a business object

request - a portal component request

Returns:

a list of OBN targets

isTargetExist

boolean isTargetExist(String systemAlias,
                      String objectName,
                      IPortalComponentRequest request)

Deprecated.

Checks if there is an iView that implements an operation that belongs to the specified business object.

Parameters:

systemAlias - a system alias

objectName - a business object

request - a portal component request

Returns:

true if the requested iView exists, false if not

isTargetExistsForOperation

boolean isTargetExistsForOperation(String systemAlias,
                                   String objectName,
                                   String operationName,
                                   IPortalComponentRequest request)

Deprecated.

Checks if there is an iView that implements the specified operation.

Parameters:

systemAlias - a system alias part

objectName - a business object

operationName - an operation name

request - a portal component request

Returns:

true if the requested iView exists, false if not

getDefaultTargetForOperation

IOBNTarget getDefaultTargetForOperation(String systemAlias,
                                        String businessObjName,
                                        String operationName,
                                        IPortalComponentRequest request)

Deprecated.

Gets the default OBN target that implements the specified operation that belongs to the specified business object. An OBN target is a single pair of iView, Operation.
The returned pair must fulfill the following conditions:

• The operation is implemented by the iView.
• The operation has the highest priority of all other pairs.

Parameters:

systemAlias - a system alias part

businessObjName - a business object

operationName - an operation name

request - a portal component request

Returns:

the OBN target

getTargetsForOperation

Set getTargetsForOperation(String systemName,
                           String objectName,
                           String operationName,
                           IPortalComponentRequest request)
                           throws NamingException

Deprecated.

Gets a list of iViews that implement the specified operation.

Parameters:

systemName - a system alias

objectName - a business object

operationName - an operation name

request - a portal component request

Returns:

a list of OBN targets

Throws:

NamingException

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