This is the primary interface for performing persistent store operations
on ShellDefinitions
. 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".
ShellDefinitionManager
Method Summary |
public |
|
public void |
|
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
Method Detail |
publicCreates a new ShellView Definition with its placeholders.ShellDefinition
createShellDefinition(CustomizationContext
customizationContext,ShellDefinition
shellDefinition)
throwsMissingDataException
,NotEntitledException
,RemoteException
MissingDataException
NotEntitledException
RemoteException
public void deleteShellDefinition(CustomizationContext
customizationContext,ShellDefinitionId
shellDefinitionId)
throwsObjectNotFoundException
,ObjectInUseException
,NotEntitledException
,RemoteException
Delete a shell definition.
ObjectNotFoundException
ObjectInUseException
NotEntitledException
RemoteException
Related Topics
public void deleteShellDefinitionWithReplacement(CustomizationContext
customizationContext,ShellDefinitionId
deleteShellDefinitionId,ShellDefinitionId
replacementShellDefinitionId)
throwsObjectNotFoundException
,NotEntitledException
,RemoteException
Delete a shell definition and replace any uses of that shell with a replacement shell. This method is useful for deleting a shell that is in use by book instances and not having to delete those book instances.
ObjectNotFoundException
NotEntitledException
RemoteException
Related Topics
IShellDefinitionManager.deleteShellDefinition(CustomizationContext, ShellDefinitionId)
publicShellDefinition
getShellDefinition(CustomizationContext
customizationContext,ShellDefinitionId
shellDefinitionId)
throwsRemoteException
Getter for returning a single ShellDefinition
object given a supplied shell
definition identifier.
ShellDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
RemoteException
Related Topics
publicShellDefinition
getShellDefinitionFromFile(CustomizationContext
customizationContext,String
shellFile,String
webAppName)
throwsRemoteException
Return a shel definition with the shellFile equal to the supplied filePath. The webAppName name is the deployed name of the module, and is often the name of the WAR file or directory, although this is not always the case. This name is that name given in config.xml as the Name of the WebAppComponent element (and thus WebAppComponentMBean's Name attribute). Note that this name is not the name of the URL context root.
RemoteException
publicShellDefinitionId
getShellDefinitionId(CustomizationContext
customizationContext,String
markupName,String
webAppName)
throwsRemoteException
Getter for returning a single ShellDefinitionId
object given a supplied shell
markup name.
RemoteException
publicShellDefinition
[] getShellDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
Getter for returning a list of all ShellDefinitions
scoped to the supplied webapp.
RemoteException
Related Topics
publicShellDefinition
[] getShellDefinitions(CustomizationContext
customizationContext,String
webapp,ShellDefinitionId
firstShellDefinitionId, int limit)
throwsRemoteException
Returns ShellDefinition
s in definitionId
order (create order). Starting
with the supplied definitionId and limiting the result set to size limit
If fewer ShellDefinition
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 shellDefinitionId
.
To retrieve from the end of the list and back specify null
as the shellDefinitionId
and a negative limit
.
To retrieve all the shellDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return ShellDefinition
s in a consistent
order.
ShellDefinition
s no greater than limit
in size. RemoteException
publicShellView
getShellView(CustomizationContext
customizationContext,ShellDefinitionId
shellDefinitionId)
throwsRemoteException
Getter for returning an immutable deep copy of a ShellView. The ShellView
object, unlike the ShellDefinition
or the ShellInstance
objects
contains a full set of references to all child pages, shells and so on. The
ShellView
object however is immutable.
RemoteException
public void updateShellDefinition(CustomizationContext
customizationContext,ShellDefinition
shellDefinition)
throwsObjectNotFoundException
,NotEntitledException
,RemoteException
Update the shell definition with the new data.
ObjectNotFoundException
NotEntitledException
RemoteException