com.sap.tc.webdynpro.services.sal.repository.api
Interface IWDRepositoryFactory

public interface IWDRepositoryFactory

Factory for repositories and repository structure manager.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_services/java/com/sap/tc/webdynpro/services/sal/repository/api/IWDRepositoryFactory.java#2 $

Method Summary

IWDCustomizingLayer	getCustomizingLayer(java.lang.String name) Returns the specified customizing layer.
IWDRepository	getEditableRepository(java.util.Locale locale, IWDVariant variant, IWDCustomizingLayer customizingLayer) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. No replacement is available, since the editable mode of the Web Dynpro runtime repository might no longer be supported.
IWDRepository	getPersonalizedRepository(java.util.Locale locale, com.sap.security.api.IUser user, IWDVariant variant) Returns a new repository instance with personalization.
IWDRepository	getPersonalizedRepository(java.util.Locale locale, com.sap.security.api.IUser user, IWDVariant[] variants) Returns a new repository instance with personalization.
IWDRepository	getRepository(java.util.Locale locale, IWDVariant variant) Returns a new repository instance.
IWDRepository	getRepository(java.util.Locale locale, IWDVariant[] variants) Returns a new repository instance.
IWDRepositoryStructureManager	getStructureManager() Returns a new structure manager instance.
IWDVariant	getVariant(java.lang.String name) Returns the specified variant.
void	setDevelopmentComponent(java.lang.String name) Sets the development component.
void	setDtrInformation(java.lang.String host, int port, java.lang.String basePath, java.lang.String scLocation, java.lang.String user, java.lang.String pwd) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. No replacement is available, since the connection to DTR of the Web Dynpro runtime repository might no longer be supported.
void	setRuntimeCustomizingLayer(java.lang.String customizingLayerName) Sets the name of the customizing layer.
void	setVersioningClient(com.sap.tc.webdynpro.rdc.api.IClient dtrClient) Deprecated. Use setDtrInformation(String, int, String, String, String, String) instead. This API may be withdrawn with the first new NetWeaver release in 2006.

Method Detail

getRepository

public IWDRepository getRepository(java.util.Locale locale,
                                   IWDVariant variant)

Returns a new repository instance. The repository instance is opened in runtime mode, i.e. only transient changes of the repository are possible.

Parameters:

locale - the default locale for which the repository is opened

variant - the variant for which the repository is opened

Returns:

the newly created repository instance

Throws:

NullPointerException - if one of the input parameters is null

getRepository

public IWDRepository getRepository(java.util.Locale locale,
                                   IWDVariant[] variants)

Returns a new repository instance.

Parameters:

locale - the default locale for which the repository is opened

variants - the variants (variant with highest priority is on index 0) for which the repository is opened

Returns:

the newly created repository instance

Throws:

NullPointerException - if one of the input parameters is null, or variants is empty or contains a null value

getPersonalizedRepository

public IWDRepository getPersonalizedRepository(java.util.Locale locale,
                                               com.sap.security.api.IUser user,
                                               IWDVariant variant)

Returns a new repository instance with personalization. The repository instance is opened in runtime mode, i.e. only transient changes of the repository are possible.

Parameters:

locale - the default locale for which the repository is opened

user - the user which is used for personalization

variant - the variant for which the repository is opened

Returns:

the newly created repository instance

Throws:

NullPointerException - if one of the input parameters is null

getPersonalizedRepository

public IWDRepository getPersonalizedRepository(java.util.Locale locale,
                                               com.sap.security.api.IUser user,
                                               IWDVariant[] variants)

Returns a new repository instance with personalization.

Parameters:

locale - the default locale for which the repository is opened

user - the user which is used for personalization

variants - the variants (variant with highest priority is on index 0) for which the repository is opened

Returns:

the newly created repository instance

Throws:

NullPointerException - if one of the input parameters is null, or variants is empty or contains a null value

getEditableRepository

public IWDRepository getEditableRepository(java.util.Locale locale,
                                           IWDVariant variant,
                                           IWDCustomizingLayer customizingLayer)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. No replacement is available, since the editable mode of the Web Dynpro runtime repository might no longer be supported.

Returns a new repository instance. The repository instance is opened in maintenance mode, i.e. persistent changes of the repository are possible.

Parameters:

locale - the default locale for which the repository is opened

variant - the variant for which the repository is be opened

customizingLayer - the customizing layer for which the repository is opended

Returns:

the newly created repository instance

Throws:

NullPointerException - if one of the input parameters are null

getStructureManager

public IWDRepositoryStructureManager getStructureManager()

Returns a new structure manager instance.

Returns:

a new structure manager instance

getVariant

public IWDVariant getVariant(java.lang.String name)

Returns the specified variant. The returned variant cannot be modified and should only be used to open a repository. To modify a variant, the IWDRepositoryStructureManager has to be used.

Parameters:

name - the name of the variant

Returns:

the requested variant or null if no such variant exists

getCustomizingLayer

public IWDCustomizingLayer getCustomizingLayer(java.lang.String name)

Returns the specified customizing layer. The returned customizing layer cannot be modified and should only be used to open a repository. To modify a customizing layer , the IWDRepositoryStructureManager has to be used.

Parameters:

name - the name of the customizing layer

Returns:

the requested customizing layer or null if no such customizing layer exists

setVersioningClient

public void setVersioningClient(com.sap.tc.webdynpro.rdc.api.IClient dtrClient)

Deprecated. Use setDtrInformation(String, int, String, String, String, String) instead. This API may be withdrawn with the first new NetWeaver release in 2006.

Sets the versioning client. This versioning client is passed to newly created editable IWDRepository and IWDRepositoryStructureManager instances.

Parameters:

dtrClient - versioning client

setDtrInformation

public void setDtrInformation(java.lang.String host,
                              int port,
                              java.lang.String basePath,
                              java.lang.String scLocation,
                              java.lang.String user,
                              java.lang.String pwd)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006. No replacement is available, since the connection to DTR of the Web Dynpro runtime repository might no longer be supported.

Sets the information needed to create the versioning client. The method must only be called if the repository is to be connected to a design time repository (DTR) in maintenance mode.

Parameters:

host - host of DTR

port - port of DTR

basePath - base path of DTR (usually "/dtr")

scLocation - location of the software component

user - user used to connect to the DTR

pwd - password of the user

setDevelopmentComponent

public void setDevelopmentComponent(java.lang.String name)

Sets the development component. This is passed to newly created editable IWDRepository and IWDRepositoryStructureManager instances.

Parameters:

name - name of the development component

setRuntimeCustomizingLayer

public void setRuntimeCustomizingLayer(java.lang.String customizingLayerName)

Sets the name of the customizing layer. This customizing layer is used for repositories opened in runtime mode. If this method is not called the system wide customizing layer is used. This setting takes only effect on the current factory instance.

Parameters:

customizingLayerName - Name of the customizing layer to set