com.sapportals.portal.navigation.obn

Interface IObjectBasedNavigationProvider

Deprecated. Please refer to the documentation of package com.sap.portal.obn

public interface IObjectBasedNavigationProvider

The interface that provides methods to create a context menu for object-based navigation (OBN).

Method Summary

IObjectBasedNavigationRenderer	createObjectNavigateContextMenuDefaultRenderer(String systemAlias, String businessObjName, IPortalComponentRequest request) Deprecated. Please refer to the documentation of package com.sap.portal.obn
IObjectBasedNavigationRenderer	createObjectNavigateContextMenuDefaultRenderer(String systemAlias, String businessObjName, IPortalComponentRequest request, String windowPrefix) Deprecated. Please refer to the documentation of package com.sap.portal.obn
IObjectBasedNavigationRenderer	createObjectNavigateContextMenuOptimizedRenderer(String systemAlias, String businessObjName, IPortalComponentRequest request) Deprecated. Please refer to the documentation of package com.sap.portal.obn
IObjectBasedNavigationRenderer	createObjectNavigateContextMenuOptimizedRenderer(String systemAlias, String businessObjName, IPortalComponentRequest request, String windowPrefix) Deprecated. Please refer to the documentation of package com.sap.portal.obn
com.sapportals.htmlb.table.ICellRenderer	getObnCellRenderer(IObjectBasedNavigationRenderer renderer) Deprecated. Gets an HTMLB cell renderer for HTMLB tables.
com.sapportals.htmlb.table.ICellRenderer	getObnOptimizedCellRenderer(IObjectBasedNavigationRenderer renderer) Deprecated. Please refer to the documentation of package com.sap.portal.obn
com.sapportals.htmlb.type.AbstractDataType	getObnTableDataType(String title, String parameter, String value) Deprecated. Please refer to the documentation of package com.sap.portal.obn

Method Detail

createObjectNavigateContextMenuOptimizedRenderer

IObjectBasedNavigationRenderer createObjectNavigateContextMenuOptimizedRenderer(String systemAlias,
                                                                                String businessObjName,
                                                                                IPortalComponentRequest request)

Deprecated. Please refer to the documentation of package com.sap.portal.obn

Creates a context menu renderer for a specified business object.

Parameters:

systemAlias - the system alias name in which the business object is defined

businessObjName - the business object name

request - the request object

Returns:

a context menu renderer

createObjectNavigateContextMenuDefaultRenderer

IObjectBasedNavigationRenderer createObjectNavigateContextMenuDefaultRenderer(String systemAlias,
                                                                              String businessObjName,
                                                                              IPortalComponentRequest request)

Deprecated. Please refer to the documentation of package com.sap.portal.obn

Creates a context menu renderer for a specified business object.

Parameters:

systemAlias - the system alias name in which the business object is defined

businessObjName - the business object name

request - the request object

Returns:

a context menu renderer

createObjectNavigateContextMenuDefaultRenderer

IObjectBasedNavigationRenderer createObjectNavigateContextMenuDefaultRenderer(String systemAlias,
                                                                              String businessObjName,
                                                                              IPortalComponentRequest request,
                                                                              String windowPrefix)

Deprecated. Please refer to the documentation of package com.sap.portal.obn

Creates a context menu renderer object for a specified business object. Used for creating an HTMLB HoverMenu.

Parameters:

systemAlias - a system alias name in which the business object is defined

businessObjName - a business object name

request - a request object

windowPrefix - an HTML window that executes the code

Returns:

the context menu renderer

createObjectNavigateContextMenuOptimizedRenderer

IObjectBasedNavigationRenderer createObjectNavigateContextMenuOptimizedRenderer(String systemAlias,
                                                                                String businessObjName,
                                                                                IPortalComponentRequest request,
                                                                                String windowPrefix)

Deprecated. Please refer to the documentation of package com.sap.portal.obn

Creates a context menu renderer object for a specified business object. Used for creating an HTMLB context menu.

Parameters:

systemAlias - a system alias name in which the business object is defined

businessObjName - a business object name

request - a request object

windowPrefix - a HTML window that executes the code

Returns:

the context menu renderer

getObnCellRenderer

com.sapportals.htmlb.table.ICellRenderer getObnCellRenderer(IObjectBasedNavigationRenderer renderer)

Deprecated.

Gets an HTMLB cell renderer for HTMLB tables. Used to create a table with an object-based navigation context menu for each cell.

Parameters:

renderer - an object-based navigation renderer

Returns:

an HTMLB cell renderer

getObnOptimizedCellRenderer

com.sapportals.htmlb.table.ICellRenderer getObnOptimizedCellRenderer(IObjectBasedNavigationRenderer renderer)

Deprecated. Please refer to the documentation of package com.sap.portal.obn

Gets an HTMLB cell renderer for HTMLB tables. Used to create a table with an object-based navigation context menu for each cell.

Parameters:

renderer - an object-based navigation renderer

Returns:

an HTMLB cell renderer

getObnTableDataType

com.sapportals.htmlb.type.AbstractDataType getObnTableDataType(String title,
                                                               String parameter,
                                                               String value)

Deprecated. Please refer to the documentation of package com.sap.portal.obn

Gets an HTMLB abstract data type for HTMLB tables. Used to create a table with an object-based navigation context menu for each cell.

Parameters:

title - the title of a table cell

parameter - a parameter name to be passed in the OBN call

value - a parameter value to be passed in the OBN call

Returns:

an HTMLB abstract data type

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