com.sap.portal.unification

Interface IRolesOBN

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

public interface IRolesOBN

The interface that handles finding navigation targets according to client action that is performed over a business object.

The methods of this interface require an IPrincipal object.

All 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

Field Summary

static String

KEY Deprecated. The service key.

Method Summary

IOBNTarget	getDefaultTarget(String systemAlias, String objectName, String operationName, IPortalComponentRequest request, List roles) Deprecated.
IOBNTarget	getDefaultTarget(String systemAlias, String objectName, String operationName, com.sap.security.api.IPrincipal user, List roles, Locale locale) Deprecated.
List	getTargets(String systemAlias, String objectName, String operationName, com.sap.security.api.IPrincipal user, List roles, Locale locale) Deprecated.
boolean	isTargetExist(String systemAlias, String objectName, String operationName, com.sap.security.api.IPrincipal user, List roles) Deprecated.

Field Detail

KEY

static final String KEY

Deprecated.

The service key.

See Also:

Constant Field Values

Method Detail

getDefaultTarget

IOBNTarget getDefaultTarget(String systemAlias,
                            String objectName,
                            String operationName,
                            com.sap.security.api.IPrincipal user,
                            List roles,
                            Locale locale)

Deprecated.

Gets a single pair of <iView, Operation> according to to the operation priority.

The returned pair is chosen according to the following conditions:

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

Parameters:

systemAlias - system alias part of the business object name

objectName - businessObject part of the business object name

operationName - operation part of the operation full name; if null, searches all operations

user - portal user

roles - list of IRole objects to search in; if null, searches all user-assigned roles

locale - locale is needed to extract the locale operation friendly name

Returns:

the target that matches the search

getDefaultTarget

IOBNTarget getDefaultTarget(String systemAlias,
                            String objectName,
                            String operationName,
                            IPortalComponentRequest request,
                            List roles)

Deprecated.

Same as getDefaultTarget(String, String, String, IPrincipal, List, Locale), but requires an IPortalComponentRequest instead of an IPrincipal and Locale.

For internal use only.

Parameters:

systemAlias - system alias part of the business object name

objectName - businessObject part of the business object name

operationName - operation part of the operation full name; if null, searches all operations

roles - list of IRole objects to search in; if null, searches all user-assigned roles

request - an IPortalComponentRequest for extracting the IPrincipal and Locale

Returns:

the target that matches the search

getTargets

List getTargets(String systemAlias,
                String objectName,
                String operationName,
                com.sap.security.api.IPrincipal user,
                List roles,
                Locale locale)

Deprecated.

Gets a list of iViews that implement any operation that belongs to the specified business object and operation.

Every 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 - system alias part of the business object name

objectName - business object part of the business object name

operationName - operation part of the operation full name; if null, searches all operations

user - portal user

roles - list of IRole objects to search in; if null, search is done in all user-assigned roles

locale - locale is needed to extract the operation friendly name

Returns:

a list of IOBNTarget objects

isTargetExist

boolean isTargetExist(String systemAlias,
                      String objectName,
                      String operationName,
                      com.sap.security.api.IPrincipal user,
                      List roles)

Deprecated.

Checks if there are any iViews implementing any operation that belongs to the specified business object and operation.

You can save time by using this method before getDefaultTarget() and getTargets().

Parameters:

systemAlias - system alias part of the business object name

objectName - business object part of the business object name

operationName - operation part of the operation full name; if null, searches all operations

roles - list of IRole objects to search in; if null, than search is done in all user-assigned roles

user - portal user

Returns:

true if there is an iView implementing any operation that belongs to the specified business object

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