|
© 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.PortletDefinitionManagerImpl
Field Summary | |
protected static Debug |
debug
|
Constructor Summary | |
PortletDefinitionManagerImpl()
|
Method Summary | |
PortletDefinition |
clonePortletDefinition(CustomizationContext customizationContext,
PortletDefinitionId portletDefinitionId)
Clone an existing portlet definition and all of it's localization resources. |
PortletDefinition |
createPortletDefinition(CustomizationContext customizationContext,
PortletDefinition portletDefinition)
Create a new portlet definition. |
void |
deletePortletDefinition(CustomizationContext customizationContext,
PortletDefinitionId portletDefinitionId)
Delete a portlet definition, but only if it is not used byt other portlet instances. |
void |
deletePortletDefinitionWithCascade(CustomizationContext customizationContext,
PortletDefinitionId portletDefinitionId)
Delete a portlet definition and all portlet instances associated with this definition. |
void |
ejbActivate()
|
void |
ejbCreate()
|
void |
ejbPassivate()
|
void |
ejbRemove()
|
PortletDefinition |
getPortletDefinition(CustomizationContext customizationContext,
PortletDefinitionId portletDefinitionId)
Getter for returning a single PortletDefinition object given a supplied portlet
definition identifier. |
PortletDefinition |
getPortletDefinition(CustomizationContext customizationContext,
String label,
String webAppName)
Getter for returning a single PortletDefinition by Label.
|
PortletDefinition |
getPortletDefinitionFromFile(CustomizationContext customizationContext,
String portletFile,
String webAppName)
Return a portlet definitions with the portletFile equal to the supplied portlet file. |
PortletDefinition[] |
getPortletDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all PortletDefinitions scoped to the supplied webapp. |
PortletView |
getPortletView(CustomizationContext customizationContext,
PortletDefinitionId portletDefinitionId)
Getter for returning an immutable deep copy of a PortletView. |
void |
setSessionContext(SessionContext sessionContext)
|
void |
updatePortletDefinition(CustomizationContext customizationContext,
PortletDefinition portletDefinition)
Update the portlet 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 PortletDefinitionManagerImpl()
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 PortletView getPortletView(CustomizationContext customizationContext, PortletDefinitionId portletDefinitionId)
IPortletDefinitionManager
Getter for returning an immutable deep copy of a PortletView. The PortletView
object, unlike the PortletDefinition
or the PortletInstance
objects
contains a full set of references to all child portlets, portlets and so on. The
PortletView
object however is immutable.
getPortletView
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localesportletDefinitionId
- the unique portletDefinitionId.
public PortletDefinition[] getPortletDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
IPortletDefinitionManager
Getter for returning a list of all PortletDefinitions
scoped to the supplied webapp.
getPortletDefinitions
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localeswebapp
- the web application these portlet definitions are scoped to.
PortletDefinition
objects if they exist, otherwise, an empty array.
RemoteException
PortletDefinition
public PortletDefinition getPortletDefinition(CustomizationContext customizationContext, PortletDefinitionId portletDefinitionId) throws RemoteException
IPortletDefinitionManager
Getter for returning a single PortletDefinition
object given a supplied portlet
definition identifier.
getPortletDefinition
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localesportletDefinitionId
- the unique portlet definition identifier.
PortletDefinition
object fully populated and internationalized, otherwise,
null
if the object does not exist.
RemoteException
public void deletePortletDefinition(CustomizationContext customizationContext, PortletDefinitionId portletDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
IPortletDefinitionManager
Delete a portlet definition, but only if it is not used byt other portlet instances.
deletePortletDefinition
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localesportletDefinitionId
- the id of the portlet definition to delete.
NotEntitledException
- the caller is not entitled to perform this operation.
ObjectInUseException
- if portlet instances are currently using this portlet definition
ObjectNotFoundException
- if the portletDefinitionId is bogus
RemoteException
IPortletDefinitionManager.deletePortletDefinitionWithCascade(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.PortletDefinitionId)
public void deletePortletDefinitionWithCascade(CustomizationContext customizationContext, PortletDefinitionId portletDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPortletDefinitionManager
Delete a portlet definition and all portlet instances associated with this definition.
deletePortletDefinitionWithCascade
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localesportletDefinitionId
- the id of the portlet definition to delete.
NotEntitledException
- the caller is not entitled to perform this operation.
ObjectNotFoundException
- if the portletDefinitionId is bogus
RemoteException
IPortletDefinitionManager.deletePortletDefinition(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.PortletDefinitionId)
public void updatePortletDefinition(CustomizationContext customizationContext, PortletDefinition portletDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPortletDefinitionManager
Update the portlet definition with the new data.
updatePortletDefinition
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localesportletDefinition
- the portlet definition containing the new data
ObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.
RemoteException
NotEntitledException
public PortletDefinition createPortletDefinition(CustomizationContext customizationContext, PortletDefinition portletDefinition) throws RemoteException, MissingDataException, NotEntitledException, DuplicateObjectException
IPortletDefinitionManager
createPortletDefinition
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localesportletDefinition
- the object containing the data to create the new portlet definition with.
MissingDataException
- the pade definition object supplied is missing some vital data.
NotEntitledException
- caller is not entitled to perform this action
DuplicateObjectException
- if the supplied portlet's definition label is already in the database.
RemoteException
public PortletDefinition clonePortletDefinition(CustomizationContext customizationContext, PortletDefinitionId portletDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
IPortletDefinitionManager
Clone an existing portlet definition and all of it's localization resources. The localization resources are slightly mutated with a '_' in front of them as to allow the administrator to distingish from the original. Note: this method only clones the primary instance, any user instances derived from the original are not cloned.
clonePortletDefinition
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localesportletDefinitionId
- the id of the portlet definition to clone
ObjectNotFoundException
- if the portletDefinitionId is bogus.
NotEntitledException
- caller is not entitled to perform this action
RemoteException
public PortletDefinition getPortletDefinition(CustomizationContext customizationContext, String label, String webAppName) throws RemoteException
IPortletDefinitionManager
Getter for returning a single PortletDefinition
by Label.
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.
getPortletDefinition
in interface IPortletDefinitionManager
customizationContext
- customization information such as prefered localeslabel
- the unique definitionLabel for the portlet. this is an optional label that the developer can set.webAppName
- the webapp this portlet is scoped to.
PortletDefinition
object fully populated and internationalized, otherwise,
null
if the object does not exist.
RemoteException
public PortletDefinition getPortletDefinitionFromFile(CustomizationContext customizationContext, String portletFile, String webAppName) throws RemoteException
IPortletDefinitionManager
Return a portlet definitions with the portletFile equal to the supplied portlet file. 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.
getPortletDefinitionFromFile
in interface IPortletDefinitionManager
customizationContext
- portletFile
- the relative path to the portlet file from the domain directory example "beaApps/portal/.../myportlet.portlet"webAppName
- the webapp this portlet is scoped to.
RemoteException
ApplicationHelper.getWebAppName(javax.servlet.ServletContext)
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |