|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDesktopInstanceManager
This is the primary interface for performing persistent store operations
on DesktopInstance
objects. In general this interface provides coarse grain
getters and fine grain setters.
It is important to note that all methods on this interface are fully internationalized and entitled. All titles and descriptions on the objects returned by these methods are internationalized to the preferred locale. Also, all methods are entitled, meaning if the caller does not have the required credentials the method may return a subset of the actual list or be unable to perform the specified function.
Most "Instances" can be thought of as objects tied to a desktop, An Admin has instances derived from the library Definition, and the "end user" has instances derived from the admin instance. Changes made via these APIs require a DesktopDefinitionId and the changes are scoped to that desktop. In other words changes made here do not affect the library or other Desktops. If the "visitorMode" on the customization Context is set the false (default) and the user executing the call is in the "Admin" or "PortalSystemAdministrator" role then these changes take affect at the admin level, and affect ALL users. If the visitorMode is false then the changes only affect the calling user.
CustomizationContext.setVisitorMode(boolean)
Method Summary | |
---|---|
void |
deleteDesktopCustomizations(CustomizationContext customizationContext,
String username,
DesktopDefinitionId desktopDefinitionId)
Remove all the customizations for a particular user on a specific desktop. |
void |
deleteDesktopCustomizations(String username)
Remove all the customizations for a particular user. |
DesktopView |
getCustomizedDesktopView(CustomizationContext customizationContext,
String webAppName,
PortalPath portalPath,
DesktopPath desktopPath)
Getter for returning an immutable deep DesktopView. |
DesktopInstance |
getDesktopInstance(CustomizationContext customizationContext,
DesktopInstanceId desktopInstanceId)
Getter for returning a DesktopInstance identified by the supplied instance id. |
DesktopInstance |
getDesktopInstance(CustomizationContext customizationContext,
String webAppName,
PortalPath portalPath,
DesktopPath desktopPath)
Getter for returning a DesktopInstance identified by the supplied webapp, portal path,
and desktop path.. |
DesktopView |
getDesktopView(CustomizationContext customizationContext,
DesktopInstanceId desktopInstanceId)
Getter for returning an immutable deep DesktopView. |
DesktopView |
getDesktopView(CustomizationContext customizationContext,
String webAppName,
PortalPath portalPath,
DesktopPath desktopPath)
Getter for returning an immutable deep DesktopView. |
DesktopView |
getShallowDesktopView(CustomizationContext customizationContext,
String webAppName,
PortalPath portalPath,
DesktopPath desktopPath)
Getter for returning an immutable shallow copy of a DesktopView. |
DesktopInstance |
updateDesktopInstance(CustomizationContext customizationContext,
DesktopInstance desktopInstance)
Update the persistent store for the supplied DesktopInstance . |
Method Detail |
---|
DesktopView getDesktopView(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath) throws RemoteException
Getter for returning an immutable deep DesktopView. If the user has customized
the desktop then this will return the user's specific instance. The
DesktopView
object, unlike the DesktopDefinition
or
the DesktopInstance
objects contains a deep copy of all
references to all child pages, books and so on. The DesktopView
object, however is immutable.
customizationContext
- customization information such as preferred locales and desktopInstanceId.
This object may be mutated by this method, so it is best to clone it before
passing it as an argument here if you intend to use it again.webAppName
- the name of the webappportalPath
- the partial portal pathdesktopPath
- the partial desktop path
RemoteException
IDesktopDefinitionManager.getDesktopView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId)
DesktopView getShallowDesktopView(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath) throws RemoteException
Getter for returning an immutable shallow copy of a DesktopView. If the user has customized
the desktop then this will return the user's specific instance.
The DesktopView
object, unlike the DesktopDefinition
or
the DesktopInstance
objects contains a reference to the main book.
To recurse through child books and pages, use the paginated BookView.getPagedNavigableViews and
PageView.getPagedPlaceableViews . The DesktopView
object is immutable.
customizationContext
- customization information such as preferred locales and desktopInstanceId.webAppName
- the name of the webappportalPath
- the partial portal pathdesktopPath
- the partial desktop path
RemoteException
IDesktopDefinitionManager.getDesktopView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId)
DesktopView getCustomizedDesktopView(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath) throws RemoteException
Getter for returning an immutable deep DesktopView. If the user has customized
the desktop then this will return the user's specific instance otherwise null
is returned. The DesktopView
object, unlike the
DesktopDefinition
or the DesktopInstance
objects
contains a deep copy of all references to all child pages, books and so on.
The DesktopView
object, however is immutable.
customizationContext
- customization information such as preferred locales and desktopInstanceId.webAppName
- the name of the webappportalPath
- the partial portal pathdesktopPath
- the partial desktop path
RemoteException
IDesktopDefinitionManager.getDesktopView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId)
DesktopView getDesktopView(CustomizationContext customizationContext, DesktopInstanceId desktopInstanceId) throws RemoteException
Getter for returning an immutable deep DesktopView. The DesktopView
object, unlike the DesktopDefinition
or the DesktopInstance
objects
contains a deep copy of all references to all child pages, books and so on. The
DesktopView
object, however is immutable.
customizationContext
- customization information such as preferred locales and desktopInstanceId.
This object may be mutated by this method, so it is best to clone it before
passing it as an argument here if you intend to use it again.desktopInstanceId
- the unique instance id (webapp/portlaPath/desktopPath) of the desktop.
RemoteException
IDesktopDefinitionManager.getDesktopView(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId)
DesktopInstance getDesktopInstance(CustomizationContext customizationContext, DesktopInstanceId desktopInstanceId) throws RemoteException
Getter for returning a DesktopInstance
identified by the supplied instance id.
customizationContext
- customization information such as preferred locales and desktopInstanceId.desktopInstanceId
- the unique id of the instance to return
DesktopInstance
objects if it exist, otherwise null.
RemoteException
DesktopInstance getDesktopInstance(CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath) throws RemoteException
Getter for returning a DesktopInstance
identified by the supplied webapp, portal path,
and desktop path..
customizationContext
- customization information such as preferred locales and desktopInstanceId.webAppName
- the name of the webappportalPath
- the partial portal pathdesktopPath
- the partial desktop path
DesktopInstance
objects if it exist, otherwise null.
RemoteException
DesktopInstance updateDesktopInstance(CustomizationContext customizationContext, DesktopInstance desktopInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
Update the persistent store for the supplied DesktopInstance
. All attributes of the DesktopInstance
are updated in the persistent store.
desktopInstance
- the new desktop instance containing all the new data.
ObjectNotFoundException
- the DesktopInstanceId specified in the desktopInstance is bogus.
NotEntitledException
- if the caller does not have the required permissions to update this object.
RemoteException
void deleteDesktopCustomizations(String username) throws RemoteException, NotEntitledException
username
- the login name of the user.
NotEntitledException
- if the caller does not have the required permissions to delete this customization
RemoteException
void deleteDesktopCustomizations(CustomizationContext customizationContext, String username, DesktopDefinitionId desktopDefinitionId) throws RemoteException, NotEntitledException
username
- the login name of the user. If null, then customizations for all users will be removed for the given desktop.
NotEntitledException
- if the caller does not have the required permissions to delete this customization
RemoteException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |