PortalDefinitionManagerImpl Class
- public class PortalDefinitionManagerImpl
extends Object
implements IPortalDefinitionManager
, SessionBean
PortalDefinitionManagerImpl
-
Hierarchy
-
Object
PortalDefinitionManagerImpl
-
All Implemented Interfaces
-
EnterpriseBean
, IPortalDefinitionManager
, Serializable
, SessionBean
public PortalDefinition |
-
createPortalDefinition (CustomizationContext customizationContext, PortalDefinition pd)
- Creates a persistant version of a
PortalDefinition
from the provided PortalDefinition .
|
public int |
-
deletePortalDefinition (CustomizationContext customizationContext, PortalPath portalPath, String webapp)
- Deletes all (including localized) versions of a PortalDefinition.
|
public void |
-
ejbActivate ()
|
public void |
-
ejbCreate ()
|
public void |
-
ejbPassivate ()
|
public void |
-
ejbRemove ()
|
public DefinitionCount |
-
getDefinitionCount (CustomizationContext customizationContext, boolean _public)
Return a count of all the definitions in the system.
|
public int |
-
getDesktopDefinitionCount (CustomizationContext customizationContext, PortalPath portalPath, String webapp)
- Returns the number of
DesktopDefinition s under
portal portalPath .
|
public PortalPath [] |
-
getDesktopDefinitionPortals (CustomizationContext customizationContext, DesktopPath desktopPath, String webapp)
- Returns all the
PortalPath s that a
DesktopDefinition is a part of.
|
public DesktopDefinition [] |
-
getDesktopDefinitions (CustomizationContext customizationContext, PortalPath portalPath, int begin, int end, String webapp)
- Returns
DesktopDefinition s in the begin
and end range under the portal portalPath .
|
public DesktopView [] |
-
getDesktopViews (CustomizationContext customizationContext, PortalPath portalPath, int begin, int end, String webapp)
- Returns
DesktopView s in the begin and
end range under the portal portalPath .
|
public PortalDefinition |
-
getPortalDefinition (CustomizationContext customizationContext, PortalPath portalPath, String webapp)
- Returns a
PortalDefinition corresponding to a
PortalPath .
|
public int |
-
getPortalDefinitionCount (CustomizationContext customizationContext, String webapp)
- Returns the number of portals.
|
public PortalDefinition [] |
-
getPortalDefinitions (CustomizationContext customizationContext, PortalPath [] portalPaths, String webapp)
- Returns an array of
PortalDefinition s corresponding
to an array of PortalPath s.
|
public PortalView |
-
getPortalDefinitionView (CustomizationContext customizationContext, PortalPath portalPath, String webapp)
- Returns a
PortalView corresponding to a
PortalPath .
|
public PortalView [] |
-
getPortalDefinitionViews (CustomizationContext customizationContext, PortalPath [] portalPaths, String webapp)
- Returns an array of
PortalView s corresponding
to an array of PortalPath s.
|
public PortalPath [] |
-
getPortalPaths (CustomizationContext customizationContext, int begin, int end, String webapp)
- Returns an array of
PortalPath s in the
begin and end range.
|
public String [] |
-
getPortalWebApps (CustomizationContext customizationContext)
Return a set of portal webapps that are customizable.
|
public void |
-
setSessionContext (SessionContext sessionContext)
|
public void |
-
updatePortalDefinition (CustomizationContext customizationContext, PortalPath portalPath, PortalDefinition newPd)
- Updates a locale specific version of a PortalDefinition based on a new
PortalDefinition.
|
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods from class com.bea.netuix.application.manager.IPortalDefinitionManager |
createPortalDefinition , deletePortalDefinition , getDefinitionCount , getDesktopDefinitionCount , getDesktopDefinitionPortals , getDesktopDefinitions , getDesktopViews , getPortalDefinition , getPortalDefinitionCount , getPortalDefinitions , getPortalDefinitionView , getPortalDefinitionViews , getPortalPaths , getPortalWebApps , updatePortalDefinition
|
debug
protected static Debug
debug
PortalDefinitionManagerImpl
public PortalDefinitionManagerImpl()
createPortalDefinition(CustomizationContext, PortalDefinition) Method
public PortalDefinition
createPortalDefinition(CustomizationContext
customizationContext,
PortalDefinition
pd)
throws RemoteException
, NotEntitledException
, MissingDataException
, DuplicateObjectException
Creates a persistant version of a PortalDefinition
from the provided PortalDefinition
.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
pd
PortalDefinition
Returns
- handle to persisted
PortalDefinition
Exceptions
-
RemoteException
-
NotEntitledException
- if caller does not have permission for this
operation
-
MissingDataException
- if data required to create a portal is
missing
-
DuplicateObjectException
deletePortalDefinition(CustomizationContext, PortalPath, String) Method
public int deletePortalDefinition(CustomizationContext
customizationContext,
PortalPath
portalPath,
String
webapp)
throws RemoteException
, NotEntitledException
Deletes all (including localized) versions of a PortalDefinition.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPath
- PortalPath for PortalDefinition to be removed
-
webapp
- web application these desktop definitions are scoped to.
Returns
- number of portals deleted
Exceptions
-
RemoteException
-
NotEntitledException
- if caller does not have permission for this
operation
ejbActivate() Method
public void ejbActivate()
throws EJBException
Exceptions
-
EJBException
ejbCreate() Method
public void ejbCreate()
throws CreateException
, RemoteException
Exceptions
-
CreateException
-
RemoteException
ejbPassivate() Method
public void ejbPassivate()
throws EJBException
Exceptions
-
EJBException
ejbRemove() Method
public void ejbRemove()
throws EJBException
Exceptions
-
EJBException
getDefinitionCount(CustomizationContext, boolean) Method
public DefinitionCount
getDefinitionCount(CustomizationContext
customizationContext,
boolean _public)
throws RemoteException
Description copied from IPortalDefinitionManager.getDefinitionCount(CustomizationContext, boolean)
Return a count of all the definitions in the system.
Returns
- a class containing all the definitions counts
Exceptions
-
RemoteException
getDesktopDefinitionCount(CustomizationContext, PortalPath, String) Method
public int getDesktopDefinitionCount(CustomizationContext
customizationContext,
PortalPath
portalPath,
String
webapp)
throws RemoteException
Returns the number of DesktopDefinition
s under
portal
portalPath
.
Parameters
-
customizationContext
PortalPath
-
portalPath
- web application these desktop definitions are scoped to.
Returns
- number of
PortletDefinition
s under portal
represented by portalPath
Exceptions
-
RemoteException
getDesktopDefinitionPortals(CustomizationContext, DesktopPath, String) Method
public PortalPath
[] getDesktopDefinitionPortals(CustomizationContext
customizationContext,
DesktopPath
desktopPath,
String
webapp)
throws RemoteException
Returns all the PortalPath
s that a
DesktopDefinition
is a part of. Returns an empty array
if the latter is noncategorized.
Parameters
-
customizationContext
DesktopPath
-
desktopPath
- web application these desktop definitions are scoped to.
Returns
- an array of
PortalPath
s
Exceptions
-
RemoteException
getDesktopDefinitions(CustomizationContext, PortalPath, int, int, String) Method
public DesktopDefinition
[] getDesktopDefinitions(CustomizationContext
customizationContext,
PortalPath
portalPath,
int begin,
int end,
String
webapp)
throws RemoteException
Returns DesktopDefinition
s in the begin
and end
range under the portal portalPath
.
If fewer DesktopDefinition
s than (begin-end) exist
then the former number is returned. If no definitions are
found an empty array is returned.
Use this method after getting the number of
DesktopDefinition
s.
Implementation has to ensure that repeated calls to this
method return DesktopDefinition
s in a consistent
order.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPath
PortalPath
-
begin
- begin index
-
end
- end index
-
webapp
- web application these desktop definitions are scoped to.
Returns
- array of
DesktopDefinition
s
Exceptions
-
RemoteException
getDesktopViews(CustomizationContext, PortalPath, int, int, String) Method
public DesktopView
[] getDesktopViews(CustomizationContext
customizationContext,
PortalPath
portalPath,
int begin,
int end,
String
webapp)
throws RemoteException
, ObjectNotFoundException
Returns DesktopView
s in the begin
and
end
range under the portal portalPath
. If fewer
views than (begin-end) exist then the former number of views is returned.
If no views are found an empty array is returned.
Use this method after getting the number of
DesktopDefinition
s.
Implementation has to ensure that repeated calls to this
method return DesktopView
s in a consistent
order.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPath
PortalPath
-
begin
- begin index
-
end
- end index
-
webapp
- web application these desktop definitions are scoped to.
Returns
- array of
DesktopView
s
Exceptions
-
RemoteException
-
ObjectNotFoundException
getPortalDefinition(CustomizationContext, PortalPath, String) Method
public PortalDefinition
getPortalDefinition(CustomizationContext
customizationContext,
PortalPath
portalPath,
String
webapp)
throws RemoteException
, ObjectNotFoundException
Returns a PortalDefinition
corresponding to a
PortalPath
.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPath
PortalPath
-
webapp
- web application these desktop definitions are scoped to.
Returns
PortalDefinition
Exceptions
-
RemoteException
-
ObjectNotFoundException
- if no portal is found
getPortalDefinitionCount(CustomizationContext, String) Method
public int getPortalDefinitionCount(CustomizationContext
customizationContext,
String
webapp)
throws RemoteException
Returns the number of portals.
Parameters
-
customizationContext
- web application these desktop definitions are scoped to.
Returns
- number of portals
Exceptions
-
RemoteException
getPortalDefinitions(CustomizationContext, PortalPath[], String) Method
public PortalDefinition
[] getPortalDefinitions(CustomizationContext
customizationContext,
PortalPath
[] portalPaths,
String
webapp)
throws RemoteException
, ObjectNotFoundException
Returns an array of PortalDefinition
s corresponding
to an array of PortalPath
s.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPaths
- array of
PortalPath
s
-
webapp
- web application these desktop definitions are scoped to.
Returns
- array of
PortalDefinition
s
Exceptions
-
RemoteException
-
ObjectNotFoundException
- if portal for any key does not exist
getPortalDefinitionView(CustomizationContext, PortalPath, String) Method
public PortalView
getPortalDefinitionView(CustomizationContext
customizationContext,
PortalPath
portalPath,
String
webapp)
throws RemoteException
, ObjectNotFoundException
Returns a PortalView
corresponding to a
PortalPath
.
NOTE: This method returns a deep copy of a portal definition.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPath
PortalPath
-
webapp
- web application these desktop definitions are scoped to.
Returns
PortalView
Exceptions
-
RemoteException
-
ObjectNotFoundException
- if no category definition is found
getPortalDefinitionViews(CustomizationContext, PortalPath[], String) Method
public PortalView
[] getPortalDefinitionViews(CustomizationContext
customizationContext,
PortalPath
[] portalPaths,
String
webapp)
throws RemoteException
, ObjectNotFoundException
Returns an array of PortalView
s corresponding
to an array of PortalPath
s.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPaths
- array of
PortalPath
s
-
webapp
- web application these desktop definitions are scoped to.
Returns
- array of
PortalView
s
Exceptions
-
RemoteException
-
ObjectNotFoundException
- if portal for any key does not exist
getPortalPaths(CustomizationContext, int, int, String) Method
public PortalPath
[] getPortalPaths(CustomizationContext
customizationContext,
int begin,
int end,
String
webapp)
throws RemoteException
Returns an array of PortalPath
s in the
begin
and end
range. If fewer portals
than (begin-end) exist then the former number of portals is
returned. If no definitions are found an empty array is returned.
Implementation has to ensure that repeated calls to this
method return PortalPath
s in a consistent
order.
Parameters
-
customizationContext
- customization information
-
begin
- begin index
-
end
- end index
-
webapp
- web application these desktop definitions are scoped to.
Returns
- an array of
PortalPath
s
Exceptions
-
RemoteException
getPortalWebApps(CustomizationContext) Method
public String
[] getPortalWebApps(CustomizationContext
customizationContext)
throws RemoteException
Description copied from IPortalDefinitionManager.getPortalWebApps(CustomizationContext)
Return a set of portal webapps that are customizable. Customizable webapps are webapps with
customization element set to true in the netuix-config.xml file, and have at least on
of the following: .shell files.
Returns
- an array of webapp names.
Exceptions
-
RemoteException
setSessionContext(SessionContext) Method
public void setSessionContext(SessionContext
sessionContext)
throws EJBException
Exceptions
-
EJBException
updatePortalDefinition(CustomizationContext, PortalPath, PortalDefinition) Method
public void updatePortalDefinition(CustomizationContext
customizationContext,
PortalPath
portalPath,
PortalDefinition
newPd)
throws RemoteException
, ObjectNotFoundException
, ObjectInUseException
, NotEntitledException
, MissingDataException
Updates a locale specific version of a PortalDefinition based on a new
PortalDefinition.
Parameters
-
customizationContext
- customization information such as prefered
locales
-
portalPath
- PortalPath to PortalDefinition to be updated
-
newPd
- new PortalDefinition
Exceptions
-
RemoteException
-
ObjectNotFoundException
- if portal does not exist
-
ObjectInUseException
-
NotEntitledException
- if caller does not have permission for this
operation
-
MissingDataException
- if data required to update a portal is
missing