Object
IPortletDefinitionManager
, SessionBean
Object
PortletDefinitionManagerImpl
EnterpriseBean
, IPortletDefinitionManager
, Serializable
, SessionBean
Field Summary |
protected static |
|
Constructor Summary |
Method Summary |
public |
|
public |
|
public void |
|
public void |
|
public void | |
public void | |
public void | |
public void | |
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
public void |
|
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods from class com.bea.netuix.application.manager. |
|
Methods from class javax.ejb. |
ejbActivate, ejbPassivate, ejbRemove, setSessionContext |
Field Detail |
protected static Debug
debug
Constructor Detail |
public PortletDefinitionManagerImpl()
Method Detail |
publicDescription copied fromPortletDefinition
clonePortletDefinition(CustomizationContext
customizationContext,PortletDefinitionId
portletDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPortletDefinitionManager.clonePortletDefinition(CustomizationContext, PortletDefinitionId)
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.
RemoteException
ObjectNotFoundException
NotEntitledException
publicDescription copied fromPortletDefinition
createPortletDefinition(CustomizationContext
customizationContext,PortletDefinition
portletDefinition)
throwsRemoteException
,MissingDataException
,NotEntitledException
,DuplicateObjectException
IPortletDefinitionManager.createPortletDefinition(CustomizationContext, PortletDefinition)
RemoteException
MissingDataException
NotEntitledException
DuplicateObjectException
public void deletePortletDefinition(Description copied fromCustomizationContext
customizationContext,PortletDefinitionId
portletDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
IPortletDefinitionManager.deletePortletDefinition(CustomizationContext, PortletDefinitionId)
Delete a portlet definition, but only if it is not used byt other portlet instances.
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
public void deletePortletDefinitionWithCascade(Description copied fromCustomizationContext
customizationContext,PortletDefinitionId
portletDefinitionId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPortletDefinitionManager.deletePortletDefinitionWithCascade(CustomizationContext, PortletDefinitionId)
Delete a portlet definition and all portlet instances associated with this definition.
RemoteException
ObjectNotFoundException
NotEntitledException
public void ejbActivate()
throwsEJBException
,RemoteException
EJBException
RemoteException
public void ejbCreate()
throwsCreateException
,RemoteException
CreateException
RemoteException
public void ejbPassivate()
throwsEJBException
,RemoteException
EJBException
RemoteException
public void ejbRemove()
throwsEJBException
,RemoteException
EJBException
RemoteException
publicDescription copied fromPortletDefinition
getPortletDefinition(CustomizationContext
customizationContext,PortletDefinitionId
portletDefinitionId)
throwsRemoteException
IPortletDefinitionManager.getPortletDefinition(CustomizationContext, PortletDefinitionId)
Getter for returning a single PortletDefinition
object given a supplied portlet
definition identifier.
PortletDefinition
object fully populated and internationalized, otherwise,
null
if the object does not exist. RemoteException
publicDescription copied fromPortletDefinition
getPortletDefinition(CustomizationContext
customizationContext,String
label,String
webAppName)
throwsRemoteException
IPortletDefinitionManager.getPortletDefinition(CustomizationContext, String, String)
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.
PortletDefinition
object fully populated and internationalized, otherwise,
null
if the object does not exist. RemoteException
publicDescription copied fromPortletDefinition
getPortletDefinitionFromFile(CustomizationContext
customizationContext,String
portletFile,String
webAppName)
throwsRemoteException
IPortletDefinitionManager.getPortletDefinitionFromFile(CustomizationContext, String, String)
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.
RemoteException
publicDescription copied fromPortletDefinition
[] getPortletDefinitions(CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
IPortletDefinitionManager.getPortletDefinitions(CustomizationContext, String)
Getter for returning a list of all PortletDefinitions
scoped to the supplied webapp.
PortletDefinition
objects if they exist, otherwise, an empty array. RemoteException
publicDescription copied fromPortletDefinition
[] getPortletDefinitions(CustomizationContext
customizationContext,String
webapp,PortletDefinitionId
firstPortletDefinitionId, int limit)
throwsRemoteException
IPortletDefinitionManager.getPortletDefinitions(CustomizationContext, String, PortletDefinitionId, int)
Returns PortletDefinition
s in definitionId
order (create order). Starting
with the supplied definitionId and limiting the result set to size limit
If fewer PortletDefinition
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 portletDefinitionId
.
To retrieve from the end of the list and back specify null
as the portletDefinitionId
and a negative limit
.
To retrieve all the portletDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return PortletDefinition
s in a consistent
order.
PortletDefinition
s no greater than limit
in size. RemoteException
publicDescription copied fromPortletView
getPortletView(CustomizationContext
customizationContext,PortletDefinitionId
portletDefinitionId)
IPortletDefinitionManager.getPortletView(CustomizationContext, PortletDefinitionId)
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.
publicDescription copied fromPortletDefinition
[] searchPortletDefinitions(CustomizationContext
customizationContext,String
webapp,String
partialPortletTitle, int limit)
throwsRemoteException
IPortletDefinitionManager.searchPortletDefinitions(CustomizationContext, String, String, int)
Search for portlets given the supplied search string. Portlets with titles
matching the supplied pattern will be returned.
No more than limit
results will be returned, however a smaller number may be
returned.
Implementation has to ensure that repeated calls to this
method return PortletDefinition
s in a consistent
order.
PortletDefinition
s no greater than limit
in size. RemoteException
public void setSessionContext(SessionContext
sessionContext)
throwsEJBException
,RemoteException
EJBException
RemoteException
public void updatePortletDefinition(Description copied fromCustomizationContext
customizationContext,PortletDefinition
portletDefinition)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
IPortletDefinitionManager.updatePortletDefinition(CustomizationContext, PortletDefinition)
Update the portlet definition with the new data.
RemoteException
ObjectNotFoundException
NotEntitledException