com.bea.netuix.application.manager.persistence.jdbc
DesktopDefinitionManagerImpl Class

Exceptions

RemoteException

getDesktopDefinitions(CustomizationContext, String) Method

public DesktopDefinition[] getDesktopDefinitions(CustomizationContext customizationContext, 
                                               String webapp)
     throws RemoteException

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)

Returns DesktopDefinitions in desktopPath order (create order). Starting with the supplied desktopPath and limiting the result set to size limit If fewer DesktopDefinitions 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 DesktopDefinitions 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 DesktopDefinitions no greater than limit in size.

getDesktopView(CustomizationContext, DesktopDefinitionId) Method

public DesktopView getDesktopView(CustomizationContext customizationContext, 
                                  DesktopDefinitionId 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)

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 DesktopDefinitions 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 DesktopDefinitions 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

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