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

getShellDefinitionFromFile(CustomizationContext, String, String) Method

public ShellDefinition getShellDefinitionFromFile(CustomizationContext customizationContext, 
                                                  String shellFile, 
                                                  String webAppName)

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.

getShellDefinitionId(CustomizationContext, String, String) Method

public ShellDefinitionId getShellDefinitionId(CustomizationContext customizationContext, 
                                              String markupName, 
                                              String webAppName)
     throws RemoteException

Getter for returning a single ShellDefinitionId object given a supplied shell markup name.

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId.

markupName

the markup name attribute supplied on the tag,

webAppName

as defined in the config.xml

Returns

shellDefinitionId the unique shell definition identifier or null if none exist.

Exceptions

RemoteException

getShellDefinitions(CustomizationContext, String) Method

public ShellDefinition[] getShellDefinitions(CustomizationContext customizationContext, 
                                           String webapp)

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

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId returned.

webapp

the web application these shell definitions are scoped to.

Returns

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

getShellDefinitions(CustomizationContext, String, ShellDefinitionId, int) Method

public ShellDefinition[] getShellDefinitions(CustomizationContext customizationContext, 
                                           String webapp, 
                                           ShellDefinitionId firstShellDefinitionId, 
                                           int limit)

Returns ShellDefinitions in definitionId order (create order). Starting with the supplied definitionId and limiting the result set to size limit If fewer ShellDefinitions 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 ShellDefinitions in a consistent order.

Parameters

customizationContext

customization information such as preferred locales.

webapp

the web application these shell definitions are scoped to.

firstShellDefinitionId

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 ShellDefinitions no greater than limit in size.

getShellView(CustomizationContext, ShellDefinitionId) Method

public ShellView getShellView(CustomizationContext customizationContext, 
                              ShellDefinitionId shellDefinitionId)

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.

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId returned.

shellDefinitionId

the unique shellDefinitionId.

Returns

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

setSessionContext(SessionContext) Method

public void setSessionContext(SessionContext sessionContext)
     throws EJBException, RemoteException

Exceptions

EJBException

RemoteException

updateShellDefinition(CustomizationContext, ShellDefinition) Method

public void updateShellDefinition(CustomizationContext customizationContext, 
                                  ShellDefinition shellDefinition)
     throws ObjectNotFoundException, NotEntitledException

Update the shell definition with the new data.

Parameters

customizationContext

customization information such as prefered locales and desktopInstanceId returned.

shellDefinition

the shell definition containing the new data

Exceptions

ObjectNotFoundException

NotEntitledException