com.sap.netweaver.bc.uwl.admin

Interface IUWLConfigurationAdmin

All Superinterfaces:

IUWLConfigurationManager

public interface IUWLConfigurationAdmin

extends IUWLConfigurationManager

This interface contains all relevant methods for maintaining UWL Configuration information. This is functionally is for administration UI only.

See Also:

IUWLService, ConfigurationRoot.IConfigurationOwner, ItemType, IUWLConfigurationManager

Method Summary

void	addPersonalized(UWLContext context, String navId, NavigationNode node) Adds a personalized navigation node for the user
void	addPersonalized(UWLContext context, UWLView view) Adds view as personalized object
Object	downloadConfigurationContent(String configurationName) If configuration is registered as ZIP file then zip file InputStream is returned else string XML is returned
String	downloadXmlFromZip(String configurationName) If configuration is registered as ZIP file then XML from inside the zip is returned.
String	getConfigurationDtd() Returns the dtd file as string
ConfigurationInfo	getConfigurationInfo(String configurationName)
ConflictInfo[]	getConflictingItemtypes(UWLContext context)
UWLView	getOriginalView(String viewName, UWLContext context) Returns the UWL View object for the specified view name.
List	getRegisteredConfigurationDetails()
Set	getRegisteredConfigurations()
void	registerConfiguration(UWLContext context, String namespace, Collection itemTypes, Collection views, NavigationNode navigationRoot, ConfigurationRoot.IConfigurationOwner owner) Register ItemTypes, Views, NavigationRoot.
RegistrationResult	registerConfiguration(UWLContext context, String configurationName, ConfigurationFile xmlorZipFile, ConfigurationRoot.IConfigurationOwner configurationOwner) Method for registering new Configurations with the Universal Worklist.
void	registerConfiguration(UWLContext context, String configurationName, List itemTypes, List views, ConfigurationRoot.IConfigurationOwner configurationOwner) Registers itemTypes and views for the configuration passed.
RegistrationResult	registerConfigurationForASystem(UWLContext ctx, String namespace, String system, ConfigurationFile xmlOrZipFile, ConfigurationRoot.IConfigurationOwner owner) Method for registering Configuration specific to a system.
RegistrationResult	registerConfigurationXml(UWLContext context, String configurationName, InputStream xmlStream, ConfigurationRoot.IConfigurationOwner owner) Method for registering new Configurations with the Universal Worklist.
RegistrationResult	registerConfigurationZip(UWLContext context, String configurationName, InputStream xmlStream, ConfigurationRoot.IConfigurationOwner owner) Method for registering new Configurations with the Universal Worklist.
void	registerItemTypes(UWLContext context, String configurationName, List itemTypes, ConfigurationRoot.IConfigurationOwner configurationOwner) Registers itemTypes for the configuration passed.
int	removePersonalized(String[] viewNames) Removes all the personalized views passed for all the users.
void	removePersonalizedNavigationNode(UWLContext context, String id) Removes the personalized navigation node for the user
int	removePersonalizedView(UWLContext context, String viewName) Removes personalized view
int	removePersonalizedViewForAllUsers(String viewName) Removes the personalized view for all the users.
int	removePersonalizedViewsForUser(String userId) Removes all personalized views for the user
void	unregisterConfiguration(UWLContext context, String configurationName) Removes configuration from the Universal Worklist system.
int	unregisterConfigurationsBeginningWith(UWLContext context, String namesBeginsWith) Unregisters all configurations which begins with the text passed.

Methods inherited from interface com.sap.netweaver.bc.uwl.admin.IUWLConfigurationManager

getActionForItemType, getAllActionsForItemType, getAllItemTypes, getAllPersonalizedNavigationNodeIds, getAllPersonalizedNavigationNodes, getAllViews, getConfigAdmin, getConfigurationRoot, getConfigurationsNotShipped, getCustomAttributes, getDefaultConfiguration, getDescriptions, getItemType, getMenuItemCollectionForItemType, getNavigationNode, getNavigationNodes, getNavigationNodesForGroupId, getNavigationNodesForViewId, getPersonalizedNavigationNode, getPersonalizedView, getPersonalizedViewIds, getView, getViewForItemType, getWebflowConfigAdmin, isConfigurationRegistered

Method Detail

registerConfiguration

public RegistrationResult registerConfiguration(UWLContext context,
                                                String configurationName,
                                                ConfigurationFile xmlorZipFile,
                                                ConfigurationRoot.IConfigurationOwner configurationOwner)
                                         throws UWLException

Method for registering new Configurations with the Universal Worklist. If the configurationName is already existing,exception is thrown.

Parameters:

context -

configurationOwner - specifies the priority of registered configuration

Returns:

AdminResult not null

Throws:

UWLException - if parsing fails, or database problem or duplicate configuration names

registerConfigurationXml

public RegistrationResult registerConfigurationXml(UWLContext context,
                                                   String configurationName,
                                                   InputStream xmlStream,
                                                   ConfigurationRoot.IConfigurationOwner owner)
                                            throws UWLException

Method for registering new Configurations with the Universal Worklist. If the configurationName is already existing,exception is thrown.

Parameters:

context -

xmlStream -

Returns:

RegistrationResult not null

Throws:

UWLException - if parsing fails, or database problem or duplicate configuration names

registerConfigurationZip

public RegistrationResult registerConfigurationZip(UWLContext context,
                                                   String configurationName,
                                                   InputStream xmlStream,
                                                   ConfigurationRoot.IConfigurationOwner owner)
                                            throws UWLException

Method for registering new Configurations with the Universal Worklist. If the configurationName is already existing,exception is thrown.

Parameters:

context -

Returns:

RegistrationResult not null

Throws:

UWLException - if parsing fails, or database problem or duplicate configuration names

registerConfigurationForASystem

public RegistrationResult registerConfigurationForASystem(UWLContext ctx,
                                                          String namespace,
                                                          String system,
                                                          ConfigurationFile xmlOrZipFile,
                                                          ConfigurationRoot.IConfigurationOwner owner)
                                                   throws UWLException

Method for registering Configuration specific to a system. This method will create a new configuration with name= namespace.system and change all the item type criteria to have system checks present in them.

Parameters:

xmlOrZipFile - needed points to XML or zip file

system -

owner - whether by customer or SAP

Returns:

RegistrationResult not null

Throws:

UWLException - if parsing fails, or database problem or duplicate configuration names

registerItemTypes

public void registerItemTypes(UWLContext context,
                              String configurationName,
                              List itemTypes,
                              ConfigurationRoot.IConfigurationOwner configurationOwner)
                       throws UWLException

Registers itemTypes for the configuration passed. passed.

Parameters:

context -

itemTypes - contains item type objects

configurationOwner -

Throws:

UWLException - if duplicate configuration names

registerConfiguration

public void registerConfiguration(UWLContext context,
                                  String configurationName,
                                  List itemTypes,
                                  List views,
                                  ConfigurationRoot.IConfigurationOwner configurationOwner)
                           throws UWLException

Registers itemTypes and views for the configuration passed.

Parameters:

context -

itemTypes - contains item type objects

configurationOwner -

Throws:

UWLException - if duplicate configuration names

registerConfiguration

public void registerConfiguration(UWLContext context,
                                  String namespace,
                                  Collection itemTypes,
                                  Collection views,
                                  NavigationNode navigationRoot,
                                  ConfigurationRoot.IConfigurationOwner owner)
                           throws UWLException

Register ItemTypes, Views, NavigationRoot. None of them can be null, otherwise it will be persisted as null

Parameters:

context -

namespace - Name for configuration

itemTypes - Collection of all item types to be registered

views - Collection of all views to be registered

navigationRoot - Navigation Root to be registered

owner -

Throws:

UWLException - If duplicate configuration name exists

unregisterConfiguration

public void unregisterConfiguration(UWLContext context,
                                    String configurationName)
                             throws UWLException

Removes configuration from the Universal Worklist system. UWL shipped and UWL generated configurations can not be deleted.

Parameters:

context -

configurationName -

Throws:

UWLException - if configuration can not be deleted.

unregisterConfigurationsBeginningWith

public int unregisterConfigurationsBeginningWith(UWLContext context,
                                                 String namesBeginsWith)
                                          throws UWLException

Unregisters all configurations which begins with the text passed. So if namespace contains "com.sap.webflow", com.sap.webflow.sys01.ts001 etcc will be unregistered as well. However com.sap.webflowabc shouldnt get unregistered. So pass "com.sap.webflow." as the parameter instead.

Parameters:

context -

namesBeginsWith - not null

Returns:

number of configurations deleted

Throws:

UWLException

getRegisteredConfigurations

public Set getRegisteredConfigurations()

Returns:

all registered configuration names with Universal Worklist

getRegisteredConfigurationDetails

public List getRegisteredConfigurationDetails()

Returns:

list of ConfigurationInfo objects

getConfigurationInfo

public ConfigurationInfo getConfigurationInfo(String configurationName)
                                       throws UWLException

Parameters:

configurationName -

Returns:

configuration information for one configuration. This value is never null. If Configuration is not found,exception is thrown.

Throws:

UWLException

downloadXmlFromZip

public String downloadXmlFromZip(String configurationName)
                          throws UWLException

If configuration is registered as ZIP file then XML from inside the zip is returned.

Parameters:

configurationName -

Returns:

xml from the zip, null if it is not a zip

Throws:

UWLException

downloadConfigurationContent

public Object downloadConfigurationContent(String configurationName)
                                    throws UWLException

If configuration is registered as ZIP file then zip file InputStream is returned else string XML is returned

Parameters:

configurationName -

Returns:

Object type is either String for XML or InputStream for zip

Throws:

UWLException

getConfigurationDtd

public String getConfigurationDtd()

Returns the dtd file as string

Returns:

String not null

addPersonalized

public void addPersonalized(UWLContext context,
                            UWLView view)
                     throws UWLException

Adds view as personalized object

Parameters:

context -

view - not null

Throws:

UWLException

removePersonalizedView

public int removePersonalizedView(UWLContext context,
                                  String viewName)
                           throws UWLException

Removes personalized view

Parameters:

context -

viewName -

Returns:

number 1 if view is deleted sucessfully

Throws:

UWLException

removePersonalizedViewsForUser

public int removePersonalizedViewsForUser(String userId)
                                   throws UWLException

Removes all personalized views for the user

Parameters:

userId -

Returns:

number of views deleted

Throws:

UWLException

removePersonalized

public int removePersonalized(String[] viewNames)
                       throws UWLException

Removes all the personalized views passed for all the users.

Parameters:

viewNames - not null

Returns:

number of deleted views

Throws:

UWLException

removePersonalizedViewForAllUsers

public int removePersonalizedViewForAllUsers(String viewName)
                                      throws UWLException

Removes the personalized view for all the users.

Parameters:

viewName -

Returns:

number of views deleted

Throws:

UWLException

addPersonalized

public void addPersonalized(UWLContext context,
                            String navId,
                            NavigationNode node)
                     throws UWLException

Adds a personalized navigation node for the user

Parameters:

context -

navId -

node -

Throws:

UWLException

removePersonalizedNavigationNode

public void removePersonalizedNavigationNode(UWLContext context,
                                             String id)
                                      throws UWLException

Removes the personalized navigation node for the user

Parameters:

context -

id -

Throws:

UWLException

getConflictingItemtypes

public ConflictInfo[] getConflictingItemtypes(UWLContext context)

Parameters:

context -

Returns:

all item types that map to same external type.

getOriginalView

public UWLView getOriginalView(String viewName,
                               UWLContext context)

Returns the UWL View object for the specified view name. Unlike the ViewManager.getView, this method does not search in the personalized views.

Parameters:

viewName -

context -

Returns: