LookAndFeelDefinitionManagerImpl Class

com.bea.netuix.application.manager.persistence.jdbc
LookAndFeelDefinitionManagerImpl Class

public class LookAndFeelDefinitionManagerImpl

    extends Object
    implements ILookAndFeelDefinitionManager, IThemeDefinitionManager, SessionBean
Hierarchy
Object
  LookAndFeelDefinitionManagerImpl
All Implemented Interfaces

EnterpriseBean, ILookAndFeelDefinitionManager, IThemeDefinitionManager, Serializable, SessionBean

Field Summary
protected static Debug
debug
Debug
 

Constructor Summary
LookAndFeelDefinitionManagerImpl()
 

Method Summary
public LookAndFeelDefinition
createLookAndFeelDefinition(CustomizationContext customizationContext, LookAndFeelDefinition lookAndFeelDefinition)

Creates a new LookAndFeelView Definition.

public ThemeDefinition
createThemeDefinition(CustomizationContext customizationContext, ThemeDefinition themeDefinition)

Creates a new ThemeView Definition with its placeholders.

public void
deleteLookAndFeelDefinition(CustomizationContext customizationContext, LookAndFeelDefinitionId lookAndFeelDefinitionId)

Delete a lookAndFeel definition.

public void
deleteLookAndFeelDefinitionWithReplacement(CustomizationContext customizationContext, LookAndFeelDefinitionId deleteLookAndFeelDefinitionId, LookAndFeelDefinitionId replacementLookAndFeelDefinitionId)

Delete a lookAndFeel definition (and its skins, skeletons and themes) and replace any uses of that lookAndFeel with a replacement lookAndFeel.

public void
deleteThemeDefinition(CustomizationContext customizationContext, ThemeDefinitionId themeDefinitionId)

Delete a theme definition that is not in use.
public void
deleteThemeDefinitionWithCascade(CustomizationContext customizationContext, ThemeDefinitionId themeDefinitionId)

Delete a theme definition and remove anrefernces to it from book, pages or portlets This method is useful for deleting a theme that is in use by book, pages or portlets.
public void
ejbActivate()
public void
ejbCreate()
public void
ejbPassivate()
public void
ejbRemove()
public LookAndFeelDefinition
getLookAndFeelDefinition(CustomizationContext customizationContext, LookAndFeelDefinitionId lookAndFeelDefinitionId)

Getter for returning a single LookAndFeelDefinition object given a supplied lookAndFeel definition identifier.
public LookAndFeelDefinition
getLookAndFeelDefinitionFromFile(CustomizationContext customizationContext, String lookAndFeelFile, String webAppName)

Getter for returning a single LookAndFeelDefinition object given a supplied lookAndFeel file name.
public LookAndFeelDefinitionId
getLookAndFeelDefinitionId(CustomizationContext customizationContext, String markupName, String webAppName)

Getter for returning a single LookAndFeelDefinitionId object given a supplied lookAndFeel markup name and webapp.
public LookAndFeelDefinition[]
getLookAndFeelDefinitions(CustomizationContext customizationContext, String webapp)

Getter for returning a list of all LookAndFeelDefinitions scoped to the supplied webapp.
public LookAndFeelDefinition[]
getLookAndFeelDefinitions(CustomizationContext customizationContext, String webapp, LookAndFeelDefinitionId firstLookAndFeelDefinitionId, int limit)

Returns LookAndFeelDefinitions in definitionId order (create order).

public LookAndFeelView
getLookAndFeelView(CustomizationContext customizationContext, LookAndFeelDefinitionId lookAndFeelDefinitionId)

Getter for returning an immutable deep copy of a LookAndFeelView.

public ThemeDefinition
getThemeDefinition(CustomizationContext customizationContext, ThemeDefinitionId themeDefinitionId)

Getter for returning a single ThemeDefinition object given a supplied theme definition identifier.
public ThemeDefinition
getThemeDefinitionFromFile(CustomizationContext customizationContext, String themeFile, String webAppName)

Getter for returning a single ThemeDefinition object given a supplied theme file name.
public ThemeDefinitionId
getThemeDefinitionId(CustomizationContext customizationContext, String markupName, String webAppName)

Getter for returning a single ThemeDefinitionId object given a supplied theme markup name and webapp.
public ThemeDefinition[]
getThemeDefinitions(CustomizationContext customizationContext, String webapp)

Getter for returning a list of all ThemeDefinitions scoped to the supplied webapp.
public ThemeDefinition[]
getThemeDefinitions(CustomizationContext customizationContext, String webapp, ThemeDefinitionId firstThemeDefinitionId, int limit)

Returns ThemeDefinitions in definitionId order (create order).

public ThemeView
getThemeView(CustomizationContext customizationContext, ThemeDefinitionId themeDefinitionId)

Getter for returning an immutable deep copy of a ThemeView.

public void
setSessionContext(SessionContext sessionContext)
public void
updateLookAndFeelDefinition(CustomizationContext customizationContext, LookAndFeelDefinition lookAndFeelDefinition)

Update the lookAndFeel definition with the new data.
public void
updateThemeDefinition(CustomizationContext customizationContext, ThemeDefinition themeDefinition)

Update the theme definition with the new data.
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from class com.bea.netuix.application.manager.ILookAndFeelDefinitionManager
createLookAndFeelDefinition, deleteLookAndFeelDefinition, deleteLookAndFeelDefinitionWithReplacement, getLookAndFeelDefinition, getLookAndFeelDefinitionFromFile, getLookAndFeelDefinitionId, getLookAndFeelDefinitions, getLookAndFeelDefinitions, getLookAndFeelView, updateLookAndFeelDefinition
 
Methods from class com.bea.netuix.application.manager.IThemeDefinitionManager
createThemeDefinition, deleteThemeDefinition, deleteThemeDefinitionWithCascade, getThemeDefinition, getThemeDefinitionFromFile, getThemeDefinitionId, getThemeDefinitions, getThemeDefinitions, getThemeView, updateThemeDefinition
 
Methods from class javax.ejb.SessionBean
ejbActivate, ejbPassivate, ejbRemove, setSessionContext
 

Field Detail

debug

protected static Debug debug

 

Constructor Detail

LookAndFeelDefinitionManagerImpl

public LookAndFeelDefinitionManagerImpl()
 

Method Detail

createLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinition) Method

public LookAndFeelDefinition createLookAndFeelDefinition(CustomizationContext customizationContext, 
                                                         LookAndFeelDefinition lookAndFeelDefinition)
     throws RemoteException, MissingDataException, NotEntitledException
Description copied from ILookAndFeelDefinitionManager.createLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinition)

Creates a new LookAndFeelView Definition. While look and feels can be created by this method they should be created via a .laf file. The .laf file may be located anywhere in the webap pdirectory and immediately gets picked up by the system.

Parameters

customizationContext
customization information such as prefered locales and http request.
lookAndFeelDefinition
the lookAndFeel data and associated placeholders

Returns

a fully populated LookAndFeelDefinition

Exceptions

RemoteException
MissingDataException
NotEntitledException

createThemeDefinition(CustomizationContext, ThemeDefinition) Method

public ThemeDefinition createThemeDefinition(CustomizationContext customizationContext, 
                                             ThemeDefinition themeDefinition)
     throws RemoteException, MissingDataException, NotEntitledException
Description copied from IThemeDefinitionManager.createThemeDefinition(CustomizationContext, ThemeDefinition)

Creates a new ThemeView Definition with its placeholders. Note, while themes can be created via this method they should be created via a .theme file located anywhere in the webapp directory. Once the file is created it will be immediately be picked up by the system.

Parameters

customizationContext
customization information such as prefered locales and http request.
themeDefinition
the theme data and associated placeholders

Returns

a fully populated ThemeDefinition

Exceptions

RemoteException
MissingDataException
NotEntitledException

deleteLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinitionId) Method

public void deleteLookAndFeelDefinition(CustomizationContext customizationContext, 
                                        LookAndFeelDefinitionId lookAndFeelDefinitionId)
     throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
Description copied from ILookAndFeelDefinitionManager.deleteLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinitionId)

Delete a lookAndFeel definition. Note if the .laf file still exist the look and feel will get recreated. This method is for deleting a look and feel after the .laf file has been deleted.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
lookAndFeelDefinitionId
the id of the lookAndFeel definition to delete.

Exceptions

RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException

deleteLookAndFeelDefinitionWithReplacement(CustomizationContext, LookAndFeelDefinitionId, LookAndFeelDefinitionId) Method

public void deleteLookAndFeelDefinitionWithReplacement(CustomizationContext customizationContext, 
                                                       LookAndFeelDefinitionId deleteLookAndFeelDefinitionId, 
                                                       LookAndFeelDefinitionId replacementLookAndFeelDefinitionId)
     throws RemoteException, ObjectNotFoundException, NotEntitledException
Description copied from ILookAndFeelDefinitionManager.deleteLookAndFeelDefinitionWithReplacement(CustomizationContext, LookAndFeelDefinitionId, LookAndFeelDefinitionId)

Delete a lookAndFeel definition (and its skins, skeletons and themes) and replace any uses of that lookAndFeel with a replacement lookAndFeel. This method is useful for deleting a lookAndFeel that is in use by desktop instances and not having to delete those dektopinstances instances. Note if the .laf file still exist the look and feel will get recreated. This method is for deleting a look and feel after the .laf file has been deleted.

Parameters

customizationContext
customization information such as prefered locales and request.
deleteLookAndFeelDefinitionId
the id of the lookAndFeel definition to delete.
replacementLookAndFeelDefinitionId
the id of the replacement lookAndFeel

Exceptions

RemoteException
ObjectNotFoundException
NotEntitledException

deleteThemeDefinition(CustomizationContext, ThemeDefinitionId) Method

public void deleteThemeDefinition(CustomizationContext customizationContext, 
                                  ThemeDefinitionId themeDefinitionId)
     throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
Description copied from IThemeDefinitionManager.deleteThemeDefinition(CustomizationContext, ThemeDefinitionId)

Delete a theme definition that is not in use.

Parameters

customizationContext
customization information such as prefered locales and http request
themeDefinitionId
the id of the theme definition to delete.

Exceptions

RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException

deleteThemeDefinitionWithCascade(CustomizationContext, ThemeDefinitionId) Method

public void deleteThemeDefinitionWithCascade(CustomizationContext customizationContext, 
                                             ThemeDefinitionId themeDefinitionId)
     throws RemoteException, ObjectNotFoundException, NotEntitledException
Description copied from IThemeDefinitionManager.deleteThemeDefinitionWithCascade(CustomizationContext, ThemeDefinitionId)

Delete a theme definition and remove anrefernces to it from book, pages or portlets This method is useful for deleting a theme that is in use by book, pages or portlets.

Parameters

customizationContext
customization information such as prefered locales and http request.
themeDefinitionId
the id of the theme definition to delete.

Exceptions

RemoteException
ObjectNotFoundException
NotEntitledException

ejbActivate() Method

public void ejbActivate()
     throws EJBException, RemoteException

Exceptions

EJBException
RemoteException

ejbCreate() Method

public void ejbCreate()
     throws CreateException, RemoteException

Exceptions

CreateException
RemoteException

ejbPassivate() Method

public void ejbPassivate()
     throws EJBException, RemoteException

Exceptions

EJBException
RemoteException

ejbRemove() Method

public void ejbRemove()
     throws EJBException, RemoteException

Exceptions

EJBException
RemoteException

getLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinitionId) Method

public LookAndFeelDefinition getLookAndFeelDefinition(CustomizationContext customizationContext, 
                                                      LookAndFeelDefinitionId lookAndFeelDefinitionId)
     throws RemoteException
Description copied from ILookAndFeelDefinitionManager.getLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinitionId)

Getter for returning a single LookAndFeelDefinition object given a supplied lookAndFeel definition identifier.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
lookAndFeelDefinitionId
the unique lookAndFeel definition identifier.

Returns

a LookAndFeelDefinition object fully populated and internationalized, otherwise, null>/code> if the object does not exist.

Exceptions

RemoteException

getLookAndFeelDefinitionFromFile(CustomizationContext, String, String) Method

public LookAndFeelDefinition getLookAndFeelDefinitionFromFile(CustomizationContext customizationContext, 
                                                              String lookAndFeelFile, 
                                                              String webAppName)
     throws RemoteException
Description copied from ILookAndFeelDefinitionManager.getLookAndFeelDefinitionFromFile(CustomizationContext, String, String)

Getter for returning a single LookAndFeelDefinition object given a supplied lookAndFeel file name.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
lookAndFeelFile
the unique lookAndFeel definition identifier.

Returns

a LookAndFeelDefinition object fully populated and internationalized, otherwise, null>/code> if the object does not exist.

Exceptions

RemoteException

getLookAndFeelDefinitionId(CustomizationContext, String, String) Method

public LookAndFeelDefinitionId getLookAndFeelDefinitionId(CustomizationContext customizationContext, 
                                                          String markupName, 
                                                          String webAppName)
     throws RemoteException
Description copied from ILookAndFeelDefinitionManager.getLookAndFeelDefinitionId(CustomizationContext, String, String)

Getter for returning a single LookAndFeelDefinitionId object given a supplied lookAndFeel markup name and webapp.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
markupName
the markup name attribute supplied on the tag in the .laf file
webAppName
as defined in the config.xml

Returns

LookAndFeelDefinitionId the unique lookAndFeel definition identifier or null is non existent.

Exceptions

RemoteException

getLookAndFeelDefinitions(CustomizationContext, String) Method

public LookAndFeelDefinition[] getLookAndFeelDefinitions(CustomizationContext customizationContext, 
                                                       String webapp)
     throws RemoteException
Description copied from ILookAndFeelDefinitionManager.getLookAndFeelDefinitions(CustomizationContext, String)

Getter for returning a list of all LookAndFeelDefinitions scoped to the supplied webapp.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
webapp
the web application these lookAndFeel definitions are scoped to.

Returns

an array of LookAndFeelDefinition objects if they exist, otherwise, an empty array.

Exceptions

RemoteException

getLookAndFeelDefinitions(CustomizationContext, String, LookAndFeelDefinitionId, int) Method

public LookAndFeelDefinition[] getLookAndFeelDefinitions(CustomizationContext customizationContext, 
                                                       String webapp, 
                                                       LookAndFeelDefinitionId firstLookAndFeelDefinitionId, 
                                                       int limit)
     throws RemoteException
Description copied from ILookAndFeelDefinitionManager.getLookAndFeelDefinitions(CustomizationContext, String, LookAndFeelDefinitionId, int)

Returns LookAndFeelDefinitions in definitionId order (create order). Starting with the supplied definitionId and limiting the result set to size limit If fewer LookAndFeelDefinitions exist than limit, then a smaller result set will be returned. If no definitions are found an empty array is returned. To start at the beginning of the list specify null as the lookAndFeelDefinitionId. To retrieve from the end of the list and back specify null as the lookAndFeelDefinitionId and a negative limit. To retrieve all the lookAndFeelDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this method return LookAndFeelDefinitions in a consistent order.

Parameters

customizationContext
customization information such as preferred locales.
webapp
the web application these lookAndFeel definitions are scoped to.
firstLookAndFeelDefinitionId
optional parameter to indicate where the list should start.
limit
the maximum result set size. Note the limit may be negative indicating a reverse sort order. For all the records specify a limit of zero. Note: some elements may be pruned because of entitlements.

Returns

array of LookAndFeelDefinitions no greater than limit in size.

Exceptions

RemoteException

getLookAndFeelView(CustomizationContext, LookAndFeelDefinitionId) Method

public LookAndFeelView getLookAndFeelView(CustomizationContext customizationContext, 
                                          LookAndFeelDefinitionId lookAndFeelDefinitionId)
Description copied from ILookAndFeelDefinitionManager.getLookAndFeelView(CustomizationContext, LookAndFeelDefinitionId)

Getter for returning an immutable deep copy of a LookAndFeelView. The LookAndFeelView object, unlike the LookAndFeelDefinition or the LookAndFeelInstance objects contains a full set of references to all child pages, lookAndFeels and so on. The LookAndFeelView object however is immutable.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
lookAndFeelDefinitionId
the unique lookAndFeelDefinitionId.

Returns

an immutable deep copy LookAndFeelView object if one exist, otherwise null.

getThemeDefinition(CustomizationContext, ThemeDefinitionId) Method

public ThemeDefinition getThemeDefinition(CustomizationContext customizationContext, 
                                          ThemeDefinitionId themeDefinitionId)
     throws RemoteException
Description copied from IThemeDefinitionManager.getThemeDefinition(CustomizationContext, ThemeDefinitionId)

Getter for returning a single ThemeDefinition object given a supplied theme definition identifier.

Parameters

customizationContext
customization information such as prefered locales and http request.
themeDefinitionId
the unique theme definition identifier.

Returns

a ThemeDefinition object fully populated and internationalized, otherwise, null>/code> if the object does not exist.

Exceptions

RemoteException

getThemeDefinitionFromFile(CustomizationContext, String, String) Method

public ThemeDefinition getThemeDefinitionFromFile(CustomizationContext customizationContext, 
                                                  String themeFile, 
                                                  String webAppName)
     throws RemoteException
Description copied from IThemeDefinitionManager.getThemeDefinitionFromFile(CustomizationContext, String, String)

Getter for returning a single ThemeDefinition object given a supplied theme file name.

Parameters

customizationContext
customization information such as prefered locales and http request.
themeFile
the unique theme definition identifier.

Returns

a ThemeDefinition object fully populated and internationalized, otherwise, null>/code> if the object does not exist.

Exceptions

RemoteException

getThemeDefinitionId(CustomizationContext, String, String) Method

public ThemeDefinitionId getThemeDefinitionId(CustomizationContext customizationContext, 
                                              String markupName, 
                                              String webAppName)
     throws RemoteException
Description copied from IThemeDefinitionManager.getThemeDefinitionId(CustomizationContext, String, String)

Getter for returning a single ThemeDefinitionId object given a supplied theme markup name and webapp.

Parameters

customizationContext
customization information such as prefered locales and http request.
markupName
the markup name attribute supplied on the tag in the .laf file
webAppName
as defined in the config.xml

Returns

ThemeDefinitionId the unique theme definition identifier or null is non existent.

Exceptions

RemoteException

getThemeDefinitions(CustomizationContext, String) Method

public ThemeDefinition[] getThemeDefinitions(CustomizationContext customizationContext, 
                                           String webapp)
     throws RemoteException
Description copied from IThemeDefinitionManager.getThemeDefinitions(CustomizationContext, String)

Getter for returning a list of all ThemeDefinitions scoped to the supplied webapp.

Parameters

customizationContext
customization information such as prefered locales and http request.
webapp
the web application these theme definitions are scoped to.

Returns

an array of ThemeDefinition objects if they exist, otherwise, an empty array.

Exceptions

RemoteException

getThemeDefinitions(CustomizationContext, String, ThemeDefinitionId, int) Method

public ThemeDefinition[] getThemeDefinitions(CustomizationContext customizationContext, 
                                           String webapp, 
                                           ThemeDefinitionId firstThemeDefinitionId, 
                                           int limit)
     throws RemoteException
Description copied from IThemeDefinitionManager.getThemeDefinitions(CustomizationContext, String, ThemeDefinitionId, int)

Returns ThemeDefinitions in definitionId order (create order). Starting with the supplied definitionId and limiting the result set to size limit If fewer ThemeDefinitions exist than limit, then a smaller result set will be returned. If no definitions are found an empty array is returned. To start at the beginning of the list specify null as the themeDefinitionId. To retrieve from the end of the list and back specify null as the themeDefinitionId and a negative limit. To retrieve all the themeDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this method return ThemeDefinitions in a consistent order.

Parameters

customizationContext
customization information such as preferred locales.
webapp
the web application these theme definitions are scoped to.
firstThemeDefinitionId
optional parameter to indicate where the list should start.
limit
the maximum result set size. Note the limit may be negative indicating a reverse sort order. For all the records specify a limit of zero. Note: some elements may be pruned because of entitlements.

Returns

array of ThemeDefinitions no greater than limit in size.

Exceptions

RemoteException

getThemeView(CustomizationContext, ThemeDefinitionId) Method

public ThemeView getThemeView(CustomizationContext customizationContext, 
                              ThemeDefinitionId themeDefinitionId)
     throws RemoteException
Description copied from IThemeDefinitionManager.getThemeView(CustomizationContext, ThemeDefinitionId)

Getter for returning an immutable deep copy of a ThemeView. The ThemeView object, unlike the ThemeDefinition or the ThemeInstance objects contains a full set of references to all child pages, themes and so on. The ThemeView object however is immutable.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
themeDefinitionId
the unique themeDefinitionId.

Returns

an immutable deep copy ThemeView object if one exist, otherwise null.

Exceptions

RemoteException

setSessionContext(SessionContext) Method

public void setSessionContext(SessionContext sessionContext)
     throws EJBException, RemoteException

Exceptions

EJBException
RemoteException

updateLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinition) Method

public void updateLookAndFeelDefinition(CustomizationContext customizationContext, 
                                        LookAndFeelDefinition lookAndFeelDefinition)
     throws RemoteException, ObjectNotFoundException, NotEntitledException, MissingDataException
Description copied from ILookAndFeelDefinitionManager.updateLookAndFeelDefinition(CustomizationContext, LookAndFeelDefinition)

Update the lookAndFeel definition with the new data.

Parameters

customizationContext
customization information such as prefered locales and desktopInstanceId returned.
lookAndFeelDefinition
the lookAndFeeldefinition containing the new data

Exceptions

RemoteException
ObjectNotFoundException
NotEntitledException
MissingDataException

updateThemeDefinition(CustomizationContext, ThemeDefinition) Method

public void updateThemeDefinition(CustomizationContext customizationContext, 
                                  ThemeDefinition themeDefinition)
     throws RemoteException, ObjectNotFoundException, NotEntitledException
Description copied from IThemeDefinitionManager.updateThemeDefinition(CustomizationContext, ThemeDefinition)

Update the theme definition with the new data.

Parameters

customizationContext
customization information such as prefered locales and http request.
themeDefinition
the themedefinition containing the new data

Exceptions

RemoteException
ObjectNotFoundException
NotEntitledException