DesktopDefinitionManagerImpl Class
- public class DesktopDefinitionManagerImpl
extends Object
implements IDesktopDefinitionManager
, SessionBean
-
Hierarchy
-
Object
DesktopDefinitionManagerImpl
-
All Implemented Interfaces
-
EnterpriseBean
, IDesktopDefinitionManager
, Serializable
, SessionBean
public DesktopDefinition |
-
createDesktopDefinition (CustomizationContext customizationContext, DesktopDefinition desktopDefinition)
Creates new desktop definition.
|
public DesktopDefinition |
-
createDesktopDefinition (CustomizationContext customizationContext, DesktopView desktopView, String webapp)
Create new desktop definition in the persistent store from the given view .The view
is typically constructed via the XmlDisassembler .
|
public void |
-
deleteDesktopDefinition (CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId)
Delete the DesktopDefinition of the supplied desktop definition identifier.
|
public void |
-
deleteDesktopDefinitionWithCascade (CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId)
Delete the DesktopDefinition of the supplied desktop definition id and
all desktop instances associated with this definition.
|
public void |
-
ejbActivate ()
|
public void |
-
ejbCreate ()
|
public void |
-
ejbPassivate ()
|
public void |
-
ejbRemove ()
|
public DesktopDefinition |
-
getDesktopDefinition (CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId)
Getter for returning a single DesktopDefinition object given a supplied desktop
definition identifier.
|
public DesktopDefinition [] |
-
getDesktopDefinitions (CustomizationContext customizationContext, String webapp)
Getter for returning a list of all DesktopDefinitions scoped to the supplied webapp.
|
public DesktopDefinition [] |
-
getDesktopDefinitions (CustomizationContext customizationContext, String webAppName, PortalPath portalPath, DesktopPath desktopPath, int limit)
Returns DesktopDefinition s in desktopPath order (create order).
|
public DesktopView |
-
getDesktopView (CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId)
Getter for returning an immutable deep copy of a DesktopView.
|
public DesktopDefinition [] |
-
searchDesktopDefinitions (CustomizationContext customizationContext, String webAppName, PortalPath portalPath, String partialDesktopTitle, int limit)
Search for desktop definitions given the supplied search string.
|
public void |
-
setSessionContext (SessionContext sessionContext)
|
public void |
-
updateDesktopDefinition (CustomizationContext customizationContext, DesktopDefinition desktopDefinition)
Update the persistent store for the supplied DesktopDefinition .
|
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
debug
protected static Debug
debug
DesktopDefinitionManagerImpl
public DesktopDefinitionManagerImpl()
createDesktopDefinition(CustomizationContext, DesktopDefinition) Method
public DesktopDefinition
createDesktopDefinition(CustomizationContext
customizationContext,
DesktopDefinition
desktopDefinition)
throws RemoteException
, MissingDataException
, ObjectNotFoundException
, NotEntitledException
, DuplicateObjectException
Description copied from IDesktopDefinitionManager.createDesktopDefinition(CustomizationContext, DesktopDefinition)
Creates new desktop definition. Creates a new desktop definition in the persistent store.
This definition may be used to create desktop instance later on.
Parameters
-
customizationContext
- customization information such as prefered locales and desktopInstanceId
-
desktopDefinition
- the desktop definition object containing all the required data.
Returns
- the fully populated (DesktopDefinitionId) DesktopDefinition
Exceptions
-
RemoteException
-
MissingDataException
-
ObjectNotFoundException
-
NotEntitledException
-
DuplicateObjectException
createDesktopDefinition(CustomizationContext, DesktopView, String) Method
public DesktopDefinition
createDesktopDefinition(CustomizationContext
customizationContext,
DesktopView
desktopView,
String
webapp)
throws RemoteException
, NotEntitledException
, ViewDisassemblerException
, DuplicateObjectException
, DuplicateDefinitionException
Description copied from IDesktopDefinitionManager.createDesktopDefinition(CustomizationContext, DesktopView, String)
Create new desktop definition in the persistent store from the given view
.The view
is typically constructed via the XmlDisassembler
.
Parameters
-
customizationContext
- customization information such as prefered locales, username and request, and most
importantly disassemblerTemplateAction.
-
desktopView
- desktop view that has all the necessary information to create a desktop definition.
-
webapp
- the name of the webapp
Returns
- the desktop definition object containing all the required data.
Exceptions
-
RemoteException
-
NotEntitledException
-
ViewDisassemblerException
-
DuplicateObjectException
-
DuplicateDefinitionException
deleteDesktopDefinition(CustomizationContext, DesktopDefinitionId) Method
public void deleteDesktopDefinition(CustomizationContext
customizationContext,
DesktopDefinitionId
desktopDefinitionId)
throws RemoteException
, ObjectNotFoundException
, ObjectInUseException
, NotEntitledException
Description copied from IDesktopDefinitionManager.deleteDesktopDefinition(CustomizationContext, DesktopDefinitionId)
Delete the DesktopDefinition
of the supplied desktop definition identifier.
Parameters
-
customizationContext
- customization information such as prefered locales and desktopInstanceId
-
desktopDefinitionId
- the unique desktop definition identifier of the desktop to delete.
Exceptions
-
RemoteException
-
ObjectNotFoundException
-
ObjectInUseException
-
NotEntitledException
deleteDesktopDefinitionWithCascade(CustomizationContext, DesktopDefinitionId) Method
public void deleteDesktopDefinitionWithCascade(CustomizationContext
customizationContext,
DesktopDefinitionId
desktopDefinitionId)
throws RemoteException
, ObjectNotFoundException
, NotEntitledException
Description copied from IDesktopDefinitionManager.deleteDesktopDefinitionWithCascade(CustomizationContext, DesktopDefinitionId)
Delete the DesktopDefinition
of the supplied desktop definition id and
all desktop instances associated with this definition.
Parameters
-
customizationContext
- customization information such as prefered locales and desktopInstanceId
-
desktopDefinitionId
- the unique desktop definition identifier of the desktop to delete.
Exceptions
-
RemoteException
-
ObjectNotFoundException
-
NotEntitledException
ejbActivate() Method
public void ejbActivate()
throws EJBException
, RemoteException
Exceptions
-
EJBException
-
RemoteException
ejbCreate() Method
public void ejbCreate()
throws CreateException
, RemoteException
Exceptions
-
CreateException
-
RemoteException
ejbPassivate() Method
public void ejbPassivate()
throws EJBException
, RemoteException
Exceptions
-
EJBException
-
RemoteException
ejbRemove() Method
public void ejbRemove()
throws EJBException
, RemoteException
Exceptions
-
EJBException
-
RemoteException
getDesktopDefinition(CustomizationContext, DesktopDefinitionId) Method
public DesktopDefinition
getDesktopDefinition(CustomizationContext
customizationContext,
DesktopDefinitionId
desktopDefinitionId)
throws RemoteException
Description copied from IDesktopDefinitionManager.getDesktopDefinition(CustomizationContext, DesktopDefinitionId)
Getter for returning a single DesktopDefinition
object given a supplied desktop
definition identifier.
Parameters
-
customizationContext
- customization information such as prefered locales and desktopInstanceId
-
desktopDefinitionId
- the unique desktop definition identifier.
Returns
- a
DesktopDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
Exceptions
-
RemoteException
getDesktopDefinitions(CustomizationContext, String) Method
public DesktopDefinition
[] getDesktopDefinitions(CustomizationContext
customizationContext,
String
webapp)
throws RemoteException
Description copied from IDesktopDefinitionManager.getDesktopDefinitions(CustomizationContext, String)
Getter for returning a list of all DesktopDefinitions
scoped to the supplied webapp.
Parameters
-
customizationContext
- customization information such as prefered locales and desktopInstanceId
-
webapp
- the web application these desktop definitions are scoped to.
Returns
- an iterator of
DesktopDefinition
objects if they exist, otherwise, an empty iterator.
Exceptions
-
RemoteException
getDesktopDefinitions(CustomizationContext, String, PortalPath, DesktopPath, int) Method
public DesktopDefinition
[] getDesktopDefinitions(CustomizationContext
customizationContext,
String
webAppName,
PortalPath
portalPath,
DesktopPath
desktopPath,
int limit)
Description copied from IDesktopDefinitionManager.getDesktopDefinitions(CustomizationContext, String, PortalPath, DesktopPath, int)
Returns DesktopDefinition
s in desktopPath
order (create order). Starting
with the supplied desktopPath and limiting the result set to size limit
If fewer DesktopDefinition
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 desktopPath
.
To retrieve from the end of the list and back specify null
as the desktopPath
and a negative limit
.
To retrieve all the desktopDefinitions in the database supply a limit of 0.
Implementation has to ensure that repeated calls to this
method return DesktopDefinition
s in a consistent
order.
Parameters
-
customizationContext
- customization information such as preferred locales.
-
webAppName
- the web application these desktop definitions are scoped to.
-
portalPath
- the portal path to which these desktop definitions are scoped to.
-
desktopPath
- optional parameter to indicate where the list should start.
-
limit
- the maximum result set size. Note the limit may be negative indicating a reverse sort order.
For all the records specify a limit of zero.
Note: some elements may be pruned because of entitlements.
Returns
- array of
DesktopDefinition
s no greater than limit
in size.
getDesktopView(CustomizationContext, DesktopDefinitionId) Method
public DesktopView
getDesktopView(CustomizationContext
customizationContext,
DesktopDefinitionId
desktopDefinitionId)
Description copied from IDesktopDefinitionManager.getDesktopView(CustomizationContext, DesktopDefinitionId)
Getter for returning an immutable deep copy of a DesktopView. The DesktopView
object, unlike the DesktopDefinition
or the DesktopInstance
objects
contains a full set of references to all child shells, pages, books and so on. The
DesktopView
object however is immutable.
Parameters
-
customizationContext
- customization information such as prefered locales and desktopInstanceId
-
desktopDefinitionId
- the unique desktopDefinitionId.
Returns
- an immutable deep copy DesktopView object if one exist, otherwise null.
searchDesktopDefinitions(CustomizationContext, String, PortalPath, String, int) Method
public DesktopDefinition
[] searchDesktopDefinitions(CustomizationContext
customizationContext,
String
webAppName,
PortalPath
portalPath,
String
partialDesktopTitle,
int limit)
Description copied from IDesktopDefinitionManager.searchDesktopDefinitions(CustomizationContext, String, PortalPath, String, int)
Search for desktop definitions given the supplied search string. Desktops 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 DesktopDefinition
s in a consistent
order.
Parameters
-
customizationContext
- customization information such as preferred locales.
-
webAppName
- the web application these desktop definitions are scoped to.
-
portalPath
- a portal path to which the desktops are scoped, if null then all portal paths are searched.
-
partialDesktopTitle
- the search string for desktop title match. Note: this string may contain special
'*' and '?' characters, where '*' matches any characters and '?' matches any single character.
-
limit
- the maximum result set size. Note the limit may be negative indicating a reverse sort order.
For all the records specify a limit of zero.
Note: some elements may be pruned because of entitlements.
Returns
- array of
DesktopDefinition
s no greater than limit
in size.
setSessionContext(SessionContext) Method
public void setSessionContext(SessionContext
sessionContext)
throws EJBException
, RemoteException
Exceptions
-
EJBException
-
RemoteException
updateDesktopDefinition(CustomizationContext, DesktopDefinition) Method
public void updateDesktopDefinition(CustomizationContext
customizationContext,
DesktopDefinition
desktopDefinition)
throws RemoteException
, ObjectNotFoundException
, NotEntitledException
Description copied from IDesktopDefinitionManager.updateDesktopDefinition(CustomizationContext, DesktopDefinition)
Update the persistent store for the supplied DesktopDefinition
. All attributes of the DesktopDefinition
are updated in persistent store.
Parameters
-
customizationContext
- customization information such as prefered locales and desktopInstanceId
-
desktopDefinition
- the object containing the new data for the desktop definition.
Exceptions
-
RemoteException
-
ObjectNotFoundException
-
NotEntitledException