com.sap.netweaver.bc.uwl.config

Class ConfigurationRoot

java.lang.Object
  com.sap.netweaver.bc.uwl.config.ConfigurationRoot

All Implemented Interfaces:

Serializable

public final class ConfigurationRoot
extends Object
implements Serializable

Represents one Configuration identified uniquely by its namespace. This contains ItemTypes and Views.

See Also:

Serialized Form

Nested Class Summary

static class

ConfigurationRoot.IConfigurationOwner Class that specifies who owns the configuration.

Field Summary

static String	BPEM_FILE
static String	BPEM_NAMESPACE
static String	COLLABORATION_FILE
static String	COLLABORATION_NAMESPACE
static String	STANDARD_FILE
static String	STANDARD_NAMESPACE
static String	WEBFLOW_FILE
static String	WEBFLOW_NAMESPACE

Constructor Summary

ConfigurationRoot(String namespac, ConfigurationRoot.IConfigurationOwner own)

ConfigurationRoot(String namespac, ConfigurationRoot.IConfigurationOwner own, Collection itemTypes, Collection views, NavigationNode nn)

ConfigurationRoot(String namespac, ConfigurationRoot.IConfigurationOwner own, List itemTypes, List views)

ConfigurationRoot(String namespac, ConfigurationRoot.IConfigurationOwner own, List itemTypes, Map views)

Method Summary

void	addItemTypes(List itemTypes)
HashMap	getActionReferences()
HashMap	getCompoundExpressionReferences()
Descriptions	getGlobalDescription(String bundleName)
HashMap	getGlobalDescriptions()
DisplayAttributes	getGlobalDisplayAttributes() Returns the globalDisplayAttributes.
ItemType	getItemType(String itemTypeId)
SortedMap	getItemTypesMap()
String	getNamespace()
NavigationNode	getNavigationRoot() Returns the navigationRoot.
ConfigurationRoot.IConfigurationOwner	getOwner()
ArrayList	getPrincipals() Get all principals valid for this configuration
HashMap	getTransientDescriptions() Used internally for caching the Descriptions objects in case of resource bundles being used
String	getVersion()
UWLView	getView(String name)
SortedMap	getViewsMap()
boolean	isZip()
void	setActionReferences(HashMap map)
void	setCompoundExpressionReferences(HashMap map)
void	setGlobalDescriptions(HashMap map)
void	setGlobalDisplayAttributes(DisplayAttributes globalDisplayAttributes) Sets the globalDisplayAttributes.
void	setNavigationRoot(NavigationNode navigationRoot) Sets the navigationRoot.
void	setPrincipals(ArrayList list) Set the principals that are valid for this configuration
void	setTransientDescriptions(HashMap map) Used internally for caching the Descriptions objects in case of resource bundles being used
void	setVersion(String str)
void	setZip(boolean b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STANDARD_NAMESPACE

public static final String STANDARD_NAMESPACE

See Also:

Constant Field Values

WEBFLOW_NAMESPACE

public static final String WEBFLOW_NAMESPACE

See Also:

Constant Field Values

COLLABORATION_NAMESPACE

public static final String COLLABORATION_NAMESPACE

See Also:

Constant Field Values

BPEM_NAMESPACE

public static final String BPEM_NAMESPACE

See Also:

Constant Field Values

STANDARD_FILE

public static final String STANDARD_FILE

See Also:

Constant Field Values

WEBFLOW_FILE

public static final String WEBFLOW_FILE

See Also:

Constant Field Values

COLLABORATION_FILE

public static final String COLLABORATION_FILE

See Also:

Constant Field Values

BPEM_FILE

public static final String BPEM_FILE

See Also:

Constant Field Values

Constructor Detail

ConfigurationRoot

public ConfigurationRoot(String namespac,
                         ConfigurationRoot.IConfigurationOwner own)

Parameters:

namespace -

ConfigurationRoot

public ConfigurationRoot(String namespac,
                         ConfigurationRoot.IConfigurationOwner own,
                         List itemTypes,
                         List views)

ConfigurationRoot

public ConfigurationRoot(String namespac,
                         ConfigurationRoot.IConfigurationOwner own,
                         Collection itemTypes,
                         Collection views,
                         NavigationNode nn)

ConfigurationRoot

public ConfigurationRoot(String namespac,
                         ConfigurationRoot.IConfigurationOwner own,
                         List itemTypes,
                         Map views)

Method Detail

getPrincipals

public ArrayList getPrincipals()

Get all principals valid for this configuration

Returns:

The list of principals' uniqueIDs (String) defined in the principals/principal tag of the given configuration.

setPrincipals

public void setPrincipals(ArrayList list)

Set the principals that are valid for this configuration

Parameters:

The - list of principals' uniqueIDs (String)

getActionReferences

public HashMap getActionReferences()

setActionReferences

public void setActionReferences(HashMap map)

getOwner

public ConfigurationRoot.IConfigurationOwner getOwner()

getNamespace

public String getNamespace()

getView

public UWLView getView(String name)

getItemType

public ItemType getItemType(String itemTypeId)

getItemTypesMap

public SortedMap getItemTypesMap()

getViewsMap

public SortedMap getViewsMap()

getNavigationRoot

public NavigationNode getNavigationRoot()

Returns the navigationRoot.

Returns:

NavigationNode

setNavigationRoot

public void setNavigationRoot(NavigationNode navigationRoot)

Sets the navigationRoot.

Parameters:

navigationRoot - The navigationRoot to set

getGlobalDisplayAttributes

public DisplayAttributes getGlobalDisplayAttributes()

Returns the globalDisplayAttributes.

Returns:

DisplayAttributes

setGlobalDisplayAttributes

public void setGlobalDisplayAttributes(DisplayAttributes globalDisplayAttributes)

Sets the globalDisplayAttributes.

Parameters:

globalDisplayAttributes - The globalDisplayAttributes to set

addItemTypes

public void addItemTypes(List itemTypes)

Parameters:

itemTypes -

getVersion

public String getVersion()

setVersion

public void setVersion(String str)

setGlobalDescriptions

public void setGlobalDescriptions(HashMap map)

getGlobalDescriptions

public HashMap getGlobalDescriptions()

getGlobalDescription

public Descriptions getGlobalDescription(String bundleName)

isZip

public boolean isZip()

Returns:

setZip

public void setZip(boolean b)

Parameters:

b -

getTransientDescriptions

public HashMap getTransientDescriptions()

Used internally for caching the Descriptions objects in case of resource bundles being used

Returns:

could be null

setTransientDescriptions

public void setTransientDescriptions(HashMap map)

Used internally for caching the Descriptions objects in case of resource bundles being used

Parameters:

map -

getCompoundExpressionReferences

public HashMap getCompoundExpressionReferences()

Returns:

setCompoundExpressionReferences

public void setCompoundExpressionReferences(HashMap map)

Parameters:

map -

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL