com.sap.portal.unification
Interface IUserLocaleOBN

All Superinterfaces:

com.sapportals.portal.prt.service.IService

public interface IUserLocaleOBN

extends com.sapportals.portal.prt.service.IService

API that handles finding Navigation Tergets (e.g. iViews) according to client action that is performed over a BusinessObject.
(The APIs of this interface requires IPrincipal object) The connection between the BusinessObject and the relevant Navigation Targets is done using an Operation Object.
Operation object is bound under (i.e. Belongs to) a BusinessObject, while Operations are also implemented by a Terget.
Operation name has the following pattern: SystemAlias.BusinessObject.Operation.
The first two parts (SystemAlias.BusinessObject) are the name of the BusinessObject under which the Operation is bound.
All the methods get either the full Operation name or the BusinessObject name, and using the RoleService to find the Targets that implement the Operation.

Field Summary

static java.lang.String

KEY

Method Summary

IOBNTarget	getDefaultTarget(java.lang.String systemAlias, java.lang.String businessObjName, com.sap.security.api.IPrincipal user, java.util.Locale locale) Returns a single pair of <iView, Operation> according to to the Operation priority.
IOBNTarget	getDefaultTargetForOperation(java.lang.String systemAlias, java.lang.String businessObjName, java.lang.String operationName, com.sap.security.api.IPrincipal user, java.util.Locale locale) Returns a single pair <iView, Operation> according to to the Operation priority.
java.util.List	getTargets(java.lang.String systemAlias, java.lang.String businessObjName, com.sap.security.api.IPrincipal user, java.util.Locale locale) Returns a List of iViews that implement any operation belongs to the given BusinessObject.
java.util.Set	getTargetsForOperation(java.lang.String systemName, java.lang.String objectName, java.lang.String operationName, com.sap.security.api.IPrincipal user, java.util.Locale locale) Returns a List of iViews that implement the given operation.
boolean	isTargetExist(java.lang.String systemAlias, java.lang.String objectName, com.sap.security.api.IPrincipal user) Returns a boolean value that indicates if there is any iViews implementing any operation that belongs to the given BusinessObject.
boolean	isTargetExistsForOperation(java.lang.String systemAlias, java.lang.String objectName, java.lang.String operationName, com.sap.security.api.IPrincipal user) Returns a boolean value that indicates if there is any iViews implementing a specific operation.

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

public static final java.lang.String KEY

Method Detail

getDefaultTarget

public IOBNTarget getDefaultTarget(java.lang.String systemAlias,
                                   java.lang.String businessObjName,
                                   com.sap.security.api.IPrincipal user,
                                   java.util.Locale locale)

Returns 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 BusinessObject - The Operation is implemented by the iView - The Operation has the highest priority of all similar cases (all other pairs)

Parameters:

systemAlias - String [in] -The System alias part of the BusinessObject name

businessObjName - String [in] - The BusinessObject part of the BusinessObject name

user - IPrincipal [in]

Locale - locale [in] The Locale is needed in order to return trenalated Operation FriendlyName

Returns:

IOBNTarget - The result OBNTarget

getTargets

public java.util.List getTargets(java.lang.String systemAlias,
                                 java.lang.String businessObjName,
                                 com.sap.security.api.IPrincipal user,
                                 java.util.Locale locale)

Returns a List of iViews that implement any operation belongs to the given BusinessObject. Every iView in the result List must fulfill the following conditions:
- The Operation object belongs to the given BusinessObject
- The Operation object is implemented by the iView

Parameters:

systemAlias - String [in] - The System alias part of the BusinessObject name

businessObjName - String [in] - The BusinessObject part of the BusinessObject name

user - IPrincipal [in]

Locale - locale [in] The Locale is needed in order to return trenalated Operation FriendlyName

Returns:

List - The list of OBNTargets.

isTargetExist

public boolean isTargetExist(java.lang.String systemAlias,
                             java.lang.String objectName,
                             com.sap.security.api.IPrincipal user)

Returns a boolean value that indicates if there is any iViews implementing any operation that belongs to the given BusinessObject.

Parameters:

systemAlias - String [in] - The System alias part of the BusinessObject name

businessObjName - String [in] - The BusinessObject part of the BusinessObject name

user - IPrincipal [in]

Returns:

boolean - true if there is a result and false if not

isTargetExistsForOperation

public boolean isTargetExistsForOperation(java.lang.String systemAlias,
                                          java.lang.String objectName,
                                          java.lang.String operationName,
                                          com.sap.security.api.IPrincipal user)

Returns a boolean value that indicates if there is any iViews implementing a specific operation.

Parameters:

systemAlias - String [in] - The System alias part of the BusinessObject name

businessObjName - String [in] - The BusinessObject part of the BusinessObject name

operationName - String [in] - The Operation name

user - IPrincipal [in]

Returns:

boolean - true if there is a result and false if not

getDefaultTargetForOperation

public IOBNTarget getDefaultTargetForOperation(java.lang.String systemAlias,
                                               java.lang.String businessObjName,
                                               java.lang.String operationName,
                                               com.sap.security.api.IPrincipal user,
                                               java.util.Locale locale)

Returns a single pair <iView, Operation> according to to the Operation priority. The returned pair is chosen according to the following conditions:
- The Operation is implemented by the iView
- The Operation has the highest priority of all similar cases (all other pairs)

Parameters:

systemAlias - String [in] - The System alias part of the Operation full name

businessObjName - String [in] - The BusinessObject part of the Operationfull name

operationName - String [in] - The Operation part of the Operationfull name

user - IPrincipal [in]

Locale - locale [in] The Locale is needed in order to return trenalated Operation FriendlyName

Returns:

IOBNTarget - The result OBNTarget

getTargetsForOperation

public java.util.Set getTargetsForOperation(java.lang.String systemName,
                                            java.lang.String objectName,
                                            java.lang.String operationName,
                                            com.sap.security.api.IPrincipal user,
                                            java.util.Locale locale)
                                     throws javax.naming.NamingException

Returns a List of iViews that implement the given operation.

Parameters:

systemAlias - String [in] - The System alias part of the Operation full name

businessObjName - String [in] - The BusinessObject part of the Operation full name

operationName - String [in] - The Operation part of the Operation full name

user - IPrincipal [in]

Locale - locale [in] The Locale is needed in order to return trenalated Operation FriendlyName

Returns:

Set - The Set of OBNTargets