Defines methods to manage a hierarchy of PortalDefinition
s.
Assumes that the hierarchy is a top down tree with each portal having
only one parent portal. However, the same PortalDefinition
can reside under multiple portals.
Imposes only a one level hierarchy of PortalDefinition
s i.e. all
PortalDefinitions
s have to be first level children of the root
PortalDefinition
and cannot have chidren of their own. Also
disallows the root PortalDefinition
to have any
DesktopDefinition
s categorized under it.
"Definitions" can be thought of as objects in the Library. Objects in the library are not associated to
any one Desktop. In other words definitions can be placed on zero or more desktops and changes
made in the Library (to the definitions) are cascaded down to object on the desktops. If you are
only interested in effecting a single desktop then use the PortalCustomizationManager
and
make changes to the "Instances".
PortalDefinitionManager
Method Summary |
public |
|
public int |
|
public |
|
public |
|
public int |
|
public |
|
public |
|
public |
|
public |
|
public int |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
Method Detail |
publicCreates a persistent version of aPortalDefinition
createPortalDefinition(CustomizationContext
customizationContext,PortalDefinition
pd)
throwsRemoteException
,NotEntitledException
,MissingDataException
,DuplicateObjectException
PortalDefinition
from the provided PortalDefinition
.
PortalDefinition
PortalDefinition
RemoteException
NotEntitledException
MissingDataException
DuplicateObjectException
public int deletePortalDefinition(Deletes a PortalDefinition.CustomizationContext
customizationContext,PortalPath
portalPath,String
webapp)
throwsRemoteException
,NotEntitledException
RemoteException
NotEntitledException
publicDefinitionCount
getDefinitionCount(CustomizationContext
customizationContext, boolean _public)
throwsRemoteException
Return a count of all the definitions in the system. This method is useful for getting counts of all the definitions in the system
RemoteException
publicDefinitionCount
getDefinitionCount(CustomizationContext
customizationContext,String
webapp, boolean _public)
throwsRemoteException
Return a count of all the definitions scoped to a webapp. This method is useful for getting counts of all the definitions in a particulare webapp.
RemoteException
public int getDesktopDefinitionCount(Returns the number ofCustomizationContext
customizationContext,PortalPath
portalPath,String
webapp)
throwsRemoteException
DesktopDefinition
s under
portal
portalPath
.
PortalPath
PortletDefinition
s under portal
represented by portalPath
RemoteException
publicReturns all thePortalPath
[] getDesktopDefinitionPortals(CustomizationContext
customizationContext,DesktopPath
desktopPath,String
webapp)
throwsRemoteException
PortalPath
s that a
DesktopDefinition
is a part of. Returns an empty array
if the latter is noncategorized.
DesktopPath
PortalPath
s RemoteException
publicReturnsDesktopDefinition
[] getDesktopDefinitions(CustomizationContext
customizationContext,PortalPath
portalPath, int begin, int end,String
webapp)
throwsRemoteException
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.DesktopDefinition
s.DesktopDefinition
s in a consistent
order.
PortalPath
DesktopDefinition
s RemoteException
publicReturnsDesktopView
[] getDesktopViews(CustomizationContext
customizationContext,PortalPath
portalPath, int begin, int end,String
webapp)
throwsRemoteException
,ObjectNotFoundException
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.DesktopDefinition
s.DesktopView
s in a consistent
order.PortalPath
DesktopView
s RemoteException
ObjectNotFoundException
publicPortalDefinition
getPortalDefinition(CustomizationContext
customizationContext,PortalPath
portalPath,String
webapp)
throwsRemoteException
,ObjectNotFoundException
Returns a PortalDefinition
corresponding to a
PortalPath
.
PortalPath
PortalDefinition
RemoteException
ObjectNotFoundException
public int getPortalDefinitionCount(Returns the number of portals.CustomizationContext
customizationContext,String
webapp)
throwsRemoteException
RemoteException
publicPortalDefinition
[] getPortalDefinitions(CustomizationContext
customizationContext,PortalPath
[] portalPaths,String
webapp)
throwsRemoteException
,ObjectNotFoundException
Returns an array of PortalDefinition
s corresponding
to an array of PortalPath
s.
PortalPath
s. If null return all portal definitions PortalDefinition
s RemoteException
ObjectNotFoundException
publicPortalView
getPortalDefinitionView(CustomizationContext
customizationContext,PortalPath
portalPath,String
webapp)
throwsRemoteException
,ObjectNotFoundException
Returns a PortalView
corresponding to a
PortalPath
.
NOTE: This method returns a deep copy of a portal definition.
PortalPath
PortalView
RemoteException
ObjectNotFoundException
publicPortalView
[] getPortalDefinitionViews(CustomizationContext
customizationContext,PortalPath
[] portalPaths,String
webapp)
throwsRemoteException
,ObjectNotFoundException
Returns an array of PortalView
s corresponding
to an array of PortalPath
s.
PortalPath
s PortalView
s RemoteException
ObjectNotFoundException
publicPortalPath
[] getPortalPaths(CustomizationContext
customizationContext, int begin, int end,String
webapp)
throwsRemoteException
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.
PortalPath
s RemoteException
publicString
[] getPortalWebApps(CustomizationContext
customizationContext)
throwsRemoteException
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.
RemoteException
public void updatePortalDefinition(Updates a PortalDefinition based on a new PortalDefinition.CustomizationContext
customizationContext,PortalPath
portalPath,PortalDefinition
newPd)
throwsRemoteException
,ObjectNotFoundException
,ObjectInUseException
,NotEntitledException
,MissingDataException
RemoteException
ObjectNotFoundException
ObjectInUseException
NotEntitledException
MissingDataException