This is the primary interface for performing persistent store operations
on ThemeDefinitions
. In general this interface provides coarse grain
getters and fine grain setters.
It is important to note that all methods on this interface are fully internationalized and entitled. All titles and descriptions on the objects returned by these methods are internationalized to the prefered locale. Also, all methods are entitled, meaning if the caller does not have the required credentials the method may return a subset of the actual list or be unable to perform the specified function.
"Definitions" can be thought of as objects in the Library. Objects in the library are not associated to any one Desktop. In other words definitions can be placed on zero or more desktops and changes made in the Library (to the definitions) are cascaded down to object on the desktops. If you are only interested in effecting a single desktop then use thePortalCustomizationManager
and
make changes to the "Instances".
LookAndFeelDefinitionManager
Method Summary |
public |
|
public void |
|
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
Method Detail |
publicThemeDefinition
createThemeDefinition(CustomizationContext
customizationContext,ThemeDefinition
themeDefinition)
throwsRemoteException
,MissingDataException
,NotEntitledException
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.
RemoteException
MissingDataException
NotEntitledException
public void deleteThemeDefinition(CustomizationContext
customizationContext,ThemeDefinitionId
themeDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
Delete a theme definition that is not in use.
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
Related Topics
IThemeDefinitionManager.deleteThemeDefinitionWithCascade(CustomizationContext, ThemeDefinitionId)
public void deleteThemeDefinitionWithCascade(CustomizationContext
customizationContext,ThemeDefinitionId
themeDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
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.
RemoteException
ObjectNotFoundException
NotEntitledException
Related Topics
IThemeDefinitionManager.deleteThemeDefinition(CustomizationContext, ThemeDefinitionId)
publicThemeDefinition
getThemeDefinition(CustomizationContext
customizationContext,ThemeDefinitionId
themeDefinitionId)
throwsRemoteException
Getter for returning a single ThemeDefinition
object given a supplied theme
definition identifier.
ThemeDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
Related Topics
publicThemeDefinition
getThemeDefinitionFromFile(CustomizationContext
customizationContext,String
themeFile,String
webAppName)
throwsRemoteException
Getter for returning a single ThemeDefinition
object given a supplied theme
file name.
ThemeDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
Related Topics
publicThemeDefinitionId
getThemeDefinitionId(CustomizationContext
customizationContext,String
markupName,String
webAppName)
throwsRemoteException
Getter for returning a single ThemeDefinitionId
object given a supplied theme
markup name and webapp.
RemoteException
publicThemeDefinition
[] getThemeDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
Getter for returning a list of all ThemeDefinitions
scoped to the supplied webapp.
ThemeDefinition
objects if they exist, otherwise, an empty array. RemoteException
Related Topics
publicThemeDefinition
[] getThemeDefinitions(CustomizationContext
customizationContext,String
webapp,ThemeDefinitionId
firstThemeDefinitionId, int limit)
throwsRemoteException
Returns ThemeDefinition
s in definitionId
order (create order). Starting
with the supplied definitionId and limiting the result set to size limit
If fewer ThemeDefinition
s 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 ThemeDefinition
s in a consistent
order.
ThemeDefinition
s no greater than limit
in size. RemoteException
publicThemeView
getThemeView(CustomizationContext
customizationContext,ThemeDefinitionId
themeDefinitionId)
throwsRemoteException
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.
RemoteException
public void updateThemeDefinition(CustomizationContext
customizationContext,ThemeDefinition
themeDefinition)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Update the theme definition with the new data.
RemoteException
ObjectNotFoundException
NotEntitledException