|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bea.netuix.application.manager.persistence.jdbc.ShellDefinitionManagerImpl
Field Summary | |
protected static Debug |
debug
|
Constructor Summary | |
ShellDefinitionManagerImpl()
|
Method Summary | |
ShellDefinition |
createShellDefinition(CustomizationContext customizationContext,
ShellDefinition shellDefinition)
Creates a new ShellView Definition with its placeholders. |
void |
deleteShellDefinition(CustomizationContext customizationContext,
ShellDefinitionId shellDefinitionId)
Delete a shell definition. |
void |
deleteShellDefinitionWithReplacement(CustomizationContext customizationContext,
ShellDefinitionId deleteShellDefinitionId,
ShellDefinitionId replacementShellDefinitionId)
Delete a shell definition and replace any uses of that shell with a replacement shell. |
void |
ejbActivate()
|
void |
ejbCreate()
|
void |
ejbPassivate()
|
void |
ejbRemove()
|
ShellDefinition |
getShellDefinition(CustomizationContext customizationContext,
ShellDefinitionId shellDefinitionId)
Getter for returning a single ShellDefinition object given a supplied shell
definition identifier. |
ShellDefinition |
getShellDefinitionFromFile(CustomizationContext customizationContext,
String shellFile,
String webAppName)
Return a shel definition with the shellFile equal to the supplied filePath. |
ShellDefinitionId |
getShellDefinitionId(CustomizationContext customizationContext,
String markupName,
String webAppName)
Getter for returning a single ShellDefinitionId object given a supplied shell
markup name. |
ShellDefinition[] |
getShellDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all ShellDefinitions scoped to the supplied webapp. |
ShellView |
getShellView(CustomizationContext customizationContext,
ShellDefinitionId shellDefinitionId)
Getter for returning an immutable deep copy of a ShellView. |
void |
setSessionContext(SessionContext sessionContext)
|
void |
updateShellDefinition(CustomizationContext customizationContext,
ShellDefinition shellDefinition)
Update the shell definition with the new data. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static Debug debug
Constructor Detail |
public ShellDefinitionManagerImpl()
Method Detail |
public void ejbCreate() throws CreateException, RemoteException
CreateException
RemoteException
public void ejbActivate() throws EJBException, RemoteException
ejbActivate
in interface SessionBean
EJBException
RemoteException
public void ejbPassivate() throws EJBException, RemoteException
ejbPassivate
in interface SessionBean
EJBException
RemoteException
public void ejbRemove() throws EJBException, RemoteException
ejbRemove
in interface SessionBean
EJBException
RemoteException
public void setSessionContext(SessionContext sessionContext) throws EJBException, RemoteException
setSessionContext
in interface SessionBean
EJBException
RemoteException
public ShellView getShellView(CustomizationContext customizationContext, ShellDefinitionId shellDefinitionId)
IShellDefinitionManager
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.
getShellView
in interface IShellDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.shellDefinitionId
- the unique shellDefinitionId.
public ShellDefinition[] getShellDefinitions(CustomizationContext customizationContext, String webapp)
IShellDefinitionManager
Getter for returning a list of all ShellDefinitions
scoped to the supplied webapp.
getShellDefinitions
in interface IShellDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.webapp
- the web application these shell definitions are scoped to.
ShellDefinition
public ShellDefinition getShellDefinition(CustomizationContext customizationContext, ShellDefinitionId shellDefinitionId)
IShellDefinitionManager
Getter for returning a single ShellDefinition
object given a supplied shell
definition identifier.
getShellDefinition
in interface IShellDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.shellDefinitionId
- the unique shell definition identifier.
ShellDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.- See Also:
ShellDefinition
public ShellDefinition createShellDefinition(CustomizationContext customizationContext, ShellDefinition shellDefinition) throws MissingDataException, NotEntitledException
IShellDefinitionManager
createShellDefinition
in interface IShellDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.shellDefinition
- the shell data and associated placeholders
MissingDataException
- the shellDefiniiton supplied as an argument is missing some vital data.
NotEntitledException
- the caller is not entitled to create a new shell.public void updateShellDefinition(CustomizationContext customizationContext, ShellDefinition shellDefinition) throws ObjectNotFoundException, NotEntitledException
IShellDefinitionManager
Update the shell definition with the new data.
updateShellDefinition
in interface IShellDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.shellDefinition
- the shell definition containing the new data
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
NotEntitledException
public void deleteShellDefinition(CustomizationContext customizationContext, ShellDefinitionId shellDefinitionId) throws ObjectNotFoundException, ObjectInUseException, NotEntitledException
IShellDefinitionManager
Delete a shell definition.
deleteShellDefinition
in interface IShellDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.shellDefinitionId
- the id of the shell definition to delete.
NotEntitledException
- the caller is not entitled to perform this operation.
ObjectNotFoundException
- if the shellDefinitionId is bogus
ObjectInUseException
- if page instances are currently using this shellIShellDefinitionManager.deleteShellDefinitionWithReplacement(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.ShellDefinitionId, com.bea.netuix.application.identifier.ShellDefinitionId)
public void deleteShellDefinitionWithReplacement(CustomizationContext customizationContext, ShellDefinitionId deleteShellDefinitionId, ShellDefinitionId replacementShellDefinitionId) throws ObjectNotFoundException, NotEntitledException
IShellDefinitionManager
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.
deleteShellDefinitionWithReplacement
in interface IShellDefinitionManager
customizationContext
- customization information such as prefered locales and desktopInstanceId
returned.deleteShellDefinitionId
- the id of the shell definition to delete.replacementShellDefinitionId
- the id of the replacement shell
NotEntitledException
- the caller is not entitled to perform this operation.
ObjectNotFoundException
- if either of the shellDefinitionIds are bogusIShellDefinitionManager.deleteShellDefinition(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.ShellDefinitionId)
public ShellDefinitionId getShellDefinitionId(CustomizationContext customizationContext, String markupName, String webAppName) throws RemoteException
IShellDefinitionManager
Getter for returning a single ShellDefinitionId
object given a supplied shell
markup name.
getShellDefinitionId
in interface IShellDefinitionManager
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
RemoteException
public ShellDefinition getShellDefinitionFromFile(CustomizationContext customizationContext, String shellFile, String webAppName)
IShellDefinitionManager
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.
getShellDefinitionFromFile
in interface IShellDefinitionManager
customizationContext
- shellFile
- the relative path to the shell file from the webapp directory example "/framework/makrup/headfooter.shell"webAppName
- as defined in the config.xml
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |