com.sap.tc.webdynpro.repository.api
Interface IWDRepositoryStructureManager

public interface IWDRepositoryStructureManager

Manger repository structure. The repository structure consists of customizing layers and variants. The development component to be used for creating new objects is set by the structure manager factory when creating the structure manager.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_runtime_repository/java/com/sap/tc/webdynpro/repository/api/IWDRepositoryStructureManager.java#1 $

Method Summary

void	commitChanges() Persists all variant and customizing layer changes of this structure manager.
IWDCustomizingLayer	createCustomizingLayer(java.lang.String name) Creates a new customizing layer.
IWDVariant	createVariant(java.lang.String name) Creates a new variant.
void	deleteCustomizingLayer(IWDCustomizingLayer customizingLayer) Deletes the given customizing layer.
void	deleteVariant(IWDVariant variant) Deletes the given variant.
IWDCustomizingLayer	getCustomizingLayer(java.lang.String name) Returns the specified customizing layer.
IWDVariant	getVariant(java.lang.String name) Returns the specified variant.
boolean	hasCustomizingLayer(java.lang.String name) Returns true, iff the customizing layer with the specified name exists.
boolean	hasVariant(java.lang.String name) Returns true, iff the variant with the specified name exists.
java.util.Iterator	iterateCustomizingLayers() Iterates over all known customizing layers.
java.util.Iterator	iterateVariants() Iterates over all known variants.

Method Detail

createVariant

public IWDVariant createVariant(java.lang.String name)

Creates a new variant. Precondition: hasVariant(name) == false

Parameters:

name - name of the variant to create

Returns:

the newly created variant

getVariant

public IWDVariant getVariant(java.lang.String name)

Returns the specified variant.

Parameters:

name - the name of the variant to return

Returns:

the requested variant or null if hasVariant() == false.

hasVariant

public boolean hasVariant(java.lang.String name)

Returns true, iff the variant with the specified name exists.

Parameters:

name - the name of the variant to be checked

Returns:

true, iff the variant with the specified name exists

deleteVariant

public void deleteVariant(IWDVariant variant)

Deletes the given variant. The caller of the method is responsible to avoid orphan successor variants.

Parameters:

variant - the variant to be deleted

iterateVariants

public java.util.Iterator iterateVariants()

Iterates over all known variants. Currently, there is no specific order.

Returns:

iterator over all known variants

createCustomizingLayer

public IWDCustomizingLayer createCustomizingLayer(java.lang.String name)

Creates a new customizing layer. Precondition: hasCustomizingLayer(name) == false

Parameters:

name - name of the customizing layer to create

Returns:

the newly created customizing layer

getCustomizingLayer

public IWDCustomizingLayer getCustomizingLayer(java.lang.String name)

Returns the specified customizing layer.

Parameters:

name - name of the customizing layer to return

Returns:

the requested customizing layer or null if hasCustomizingLayer() == false.

hasCustomizingLayer

public boolean hasCustomizingLayer(java.lang.String name)

Returns true, iff the customizing layer with the specified name exists.

Parameters:

name - name of the customizing layer to check for

Returns:

true, iff the customizing layer with the specified name exists

deleteCustomizingLayer

public void deleteCustomizingLayer(IWDCustomizingLayer customizingLayer)

Deletes the given customizing layer. The caller of the method is responsible to avoid orphan successor customizing layers.

Parameters:

customizingLayer - the customizing layer to be deleted

iterateCustomizingLayers

public java.util.Iterator iterateCustomizingLayers()

Iterates over all known customizing layers. Currently, there is no specific order.

Returns:

iterator over all known customizing layers

commitChanges

public void commitChanges()

Persists all variant and customizing layer changes of this structure manager.