com.sap.netweaver.bc.uwl.admin

Interface IUWLConfigurationManager

All Known Subinterfaces:

IUWLConfigurationAdmin

public interface IUWLConfigurationManager

This interface contains all relevant methods for accessing the UWL Congifuration data.

See Also:

ItemType, UWLView, NavigationNode, IUWLService.getConfigurationManager(com.sap.netweaver.bc.uwl.UWLContext)

Method Summary

Action	getActionForItemType(String itemType, String actionName) Traverses item type hierarchy and returns the Action object
Map	getAllActionsForItemType(String itemType) Computes all the actions for the item type and returns them.
Map	getAllItemTypes() Returns unmodifiable map of item types.
String[]	getAllPersonalizedNavigationNodeIds(String userId)
NavigationNode[]	getAllPersonalizedNavigationNodes(String userId)
Map	getAllViews()
IUWLConfigurationAdmin	getConfigAdmin(UWLContext context)
ConfigurationRoot	getConfigurationRoot(String configurationName)
Set	getConfigurationsNotShipped() These are the configurations created by the user.
CustomAttributes[]	getCustomAttributes(String itemType) Returns CustomAttributes if defined for the itemType passed.
ConfigurationRoot	getDefaultConfiguration()
Descriptions	getDescriptions(String key) Searches for the Descriptions object whose key is passed here and returns the Descriptions Object.
ItemType	getItemType(String name)
MenuItemCollection	getMenuItemCollectionForItemType(String itemType) This method will look for a MenuItemCollection in the item type specified and will continue to look through the parents until it finds one.
NavigationNode	getNavigationNode(String name)
Map	getNavigationNodes() return all Navigation nodes.
List	getNavigationNodesForGroupId(String groupId) returns a list of navigation nodes which have the specified groupId.
List	getNavigationNodesForViewId(String viewId) return a list of navigation nodes which reference the specified view.
NavigationNode	getPersonalizedNavigationNode(String userId, String nodeId)
UWLView	getPersonalizedView(String userId, String viewName) Returns personalized view specified by viewName for the user specified by userId.
String[]	getPersonalizedViewIds(String userId) Returns personalized view names for a user.
UWLView	getView(String viewname)
UWLView	getViewForItemType(String itemType) For the given item type finds the associated View.
IWebflowConfigurationAdmin	getWebflowConfigAdmin(UWLContext context) Interface for Webflow Item type administration UI
boolean	isConfigurationRegistered(String configurationName)

Method Detail

getAllViews

public Map getAllViews()

Returns:

Map of viewName to UWLView, not null unmodifiable map

getView

public UWLView getView(String viewname)

Parameters:

viewname -

Returns:

view if found,could be null

getViewForItemType

public UWLView getViewForItemType(String itemType)

For the given item type finds the associated View. If no view by the name specified for that ItemType is not found, then parent itemType's view is got. Still if there are no views found then default view is returned.

Parameters:

itemType - not null

Returns:

could be null

See Also:

ItemType.getViewName()

getPersonalizedViewIds

public String[] getPersonalizedViewIds(String userId)
                                throws UWLException

Returns personalized view names for a user.

Parameters:

userId -

Returns:

all personalized view names for the user

Throws:

UWLException - in case of database problems

getPersonalizedView

public UWLView getPersonalizedView(String userId,
                                   String viewName)
                            throws UWLException

Returns personalized view specified by viewName for the user specified by userId.

Parameters:

userId -

viewName -

Returns:

could be null

Throws:

UWLException - in case of database problems

getItemType

public ItemType getItemType(String name)

Parameters:

name - not null

Returns:

could be null if item type is not found

getAllItemTypes

public Map getAllItemTypes()

Returns unmodifiable map of item types.

Returns:

Map of item type name to ItemType objects

getNavigationNode

public NavigationNode getNavigationNode(String name)

Parameters:

name -

Returns:

could be null if navigation node is not found

getNavigationNodes

public Map getNavigationNodes()

return all Navigation nodes.

Returns:

getNavigationNodesForGroupId

public List getNavigationNodesForGroupId(String groupId)

returns a list of navigation nodes which have the specified groupId.

Parameters:

groupId -

Returns:

List of NavigationNode objects.

getNavigationNodesForViewId

public List getNavigationNodesForViewId(String viewId)

return a list of navigation nodes which reference the specified view.

Parameters:

viewId -

Returns:

List of NavigationNode objects.

getPersonalizedNavigationNode

public NavigationNode getPersonalizedNavigationNode(String userId,
                                                    String nodeId)
                                             throws UWLException

Parameters:

userId -

nodeId -

Returns:

Throws:

UWLException

getAllPersonalizedNavigationNodes

public NavigationNode[] getAllPersonalizedNavigationNodes(String userId)
                                                   throws UWLException

Parameters:

userId -

Returns:

Throws:

UWLException

getAllPersonalizedNavigationNodeIds

public String[] getAllPersonalizedNavigationNodeIds(String userId)
                                             throws UWLException

Parameters:

userId -

Returns:

Throws:

UWLException

getActionForItemType

public Action getActionForItemType(String itemType,
                                   String actionName)

Traverses item type hierarchy and returns the Action object

Parameters:

itemType -

actionName -

Returns:

could be null if that action is not defined

getAllActionsForItemType

public Map getAllActionsForItemType(String itemType)

Computes all the actions for the item type and returns them. For computing Actions from parent item types are also taken into account.

Parameters:

itemType - not null

Returns:

Map of ActionName and Action Object

getMenuItemCollectionForItemType

public MenuItemCollection getMenuItemCollectionForItemType(String itemType)

This method will look for a MenuItemCollection in the item type specified and will continue to look through the parents until it finds one.

Parameters:

itemType -

Returns:

The MenuItemCollection found for the specified itemType else Null if none

getCustomAttributes

public CustomAttributes[] getCustomAttributes(String itemType)

Returns CustomAttributes if defined for the itemType passed. CustomAttributes are not propagated in the item type hierarchy.

Parameters:

itemType - not null

Returns:

could be null

getConfigAdmin

public IUWLConfigurationAdmin getConfigAdmin(UWLContext context)

Parameters:

context -

Returns:

the administration interface which contains modifier methods

getWebflowConfigAdmin

public IWebflowConfigurationAdmin getWebflowConfigAdmin(UWLContext context)

Interface for Webflow Item type administration UI

Parameters:

context -

Returns:

not null

getDefaultConfiguration

public ConfigurationRoot getDefaultConfiguration()

Returns:

configuration with id 'uwl.standard'

getDescriptions

public Descriptions getDescriptions(String key)

Searches for the Descriptions object whose key is passed here and returns the Descriptions Object.

Parameters:

key - not null for example "open_task". Returned value is read only and should not be changed by the caller.

Returns:

could be null

isConfigurationRegistered

public boolean isConfigurationRegistered(String configurationName)

Parameters:

configurationName - not null

Returns:

true if configuration is registered

getConfigurationRoot

public ConfigurationRoot getConfigurationRoot(String configurationName)

getConfigurationsNotShipped

public Set getConfigurationsNotShipped()

These are the configurations created by the user. Required because shipped configurations cannot be changed.

Returns: