|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDesktopDefinitionManager
This is the primary interface for performing persistent store operations
on DesktopDefinitions
. 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.
Method Summary | |
---|---|
DesktopDefinition |
createDesktopDefinition(CustomizationContext customizationContext,
DesktopDefinition desktopDefinition)
Creates a new desktop definition in the persistent store. |
DesktopDefinition |
createDesktopDefinition(CustomizationContext customizationContext,
DesktopView desktopView,
String webappName)
Create a new desktop definition in the persistent store from the given view . |
DesktopDefinition |
createDesktopFromTemplate(CustomizationContext customizationContext,
TemplateId templateId,
LocalizationResource desktopLocalizationResource,
PortalPath portalPath,
DesktopPath desktopPath)
Creates a new desktop definition from a template. |
DesktopDefinition |
createDesktopTemplate(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
LocalizationResource templateLocalizationResource,
PortalPath portalPath,
DesktopPath desktopPath,
boolean isGlobal)
Creates a new desktop definition from an existing desktop and marks it as a template. |
DesktopDefinition |
createDesktopTemplate(CustomizationContext customizationContext,
DesktopView desktopView,
String webappName,
boolean isGlobal)
Create a new desktop template in the persistent store from the given view . |
void |
deleteDesktopDefinition(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId)
Delete the DesktopDefinition of the supplied desktop definition identifier. |
void |
deleteDesktopDefinitionWithCascade(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId)
Delete the DesktopDefinition of the supplied desktop definition id and
all desktop instances associated with this definition. |
DesktopDefinition |
getDesktopDefinition(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId)
Getter for returning a single DesktopDefinition object given a supplied desktop
definition identifier. |
DesktopDefinition[] |
getDesktopDefinitions(CustomizationContext customizationContext,
String webapp)
Getter for returning a list of all DesktopDefinitions scoped to the supplied webapp. |
DesktopDefinition[] |
getDesktopDefinitions(CustomizationContext customizationContext,
String webapp,
PortalPath portalPath,
DesktopPath firstDesktopPath,
int limit)
Returns DesktopDefinition s in desktopPath order (create order), starting
with the supplied desktopPath and limiting the result set to size limit . |
SortableFilterablePagedResult<DesktopDefinition> |
getDesktopDefinitions(CustomizationContext customizationContext,
WebAppSearchCriteria criteria,
int pageSize)
Get all the desktop definitions in the webapp, as a paged object. |
DesktopView |
getDesktopView(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId)
Getter for returning an immutable deep DesktopView. |
DesktopView |
getShallowDesktopView(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId)
Getter for returning an immutable shallow DesktopView. |
SortableFilterablePagedResult<LocalizationResourceView> |
getVisibleDesktopLocalizationResources(CustomizationContext customizationContext,
WebAppSearchCriteria criteria,
int pageSize)
Retrieve the LocalizationResourceViews for all visible desktops for a given locale and webapp. |
DesktopDefinition[] |
searchDesktopDefinitions(CustomizationContext customizationContext,
String webapp,
PortalPath portalPath,
String partialDesktopTitle,
int limit)
Search for desktop definitions given the supplied search string. |
void |
updateDesktopDefinition(CustomizationContext customizationContext,
DesktopDefinition desktopDefinition)
Update the persistent store for the supplied DesktopDefinition . |
Method Detail |
---|
DesktopView getDesktopView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException
Getter for returning an immutable deep 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.
customizationContext
- customization information such as preferred locales and desktopInstanceIddesktopDefinitionId
- the unique desktopDefinitionId.
RemoteException
DesktopView getShallowDesktopView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException
Getter for returning an immutable shallow DesktopView. See the
comments in DesktopView for a description of what "shallow" means.
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 desktopInstanceIddesktopDefinitionId
- the unique desktopDefinitionId.
RemoteException
DesktopDefinition[] getDesktopDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
Getter for returning a list of all DesktopDefinitions
scoped to the supplied webapp.
customizationContext
- customization information such as preferred locales and desktopInstanceIdwebapp
- the web application these desktop definitions are scoped to.
DesktopDefinition
objects if they exist, otherwise, an empty iterator.
RemoteException
DesktopDefinition getDesktopDefinition(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException
Getter for returning a single DesktopDefinition
object given a supplied desktop
definition identifier.
customizationContext
- customization information such as preferred locales and desktopInstanceIddesktopDefinitionId
- the unique desktop definition identifier.
DesktopDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
- Throws
RemoteException
- See Also
DesktopDefinition
DesktopDefinition[] getDesktopDefinitions(CustomizationContext customizationContext, String webapp, PortalPath portalPath, DesktopPath firstDesktopPath, int limit) throws RemoteException
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.
The implmentation has to ensure that repeated calls to this
method return DesktopDefinition
s in a consistent
order.
customizationContext
- customization information such as preferred locales.webapp
- the web application these desktop definitions are scoped to.portalPath
- the portal path to which these desktop definitions are scoped to.firstDesktopPath
- 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.
To retrieve all the records specify a limit of zero.
Note: some elements may be pruned because of entitlements.
DesktopDefinition
s no greater than limit
in size.
RemoteException
DesktopDefinition[] searchDesktopDefinitions(CustomizationContext customizationContext, String webapp, PortalPath portalPath, String partialDesktopTitle, int limit) throws RemoteException
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.
The implmentation has to ensure that repeated calls to this
method return DesktopDefinition
s in a consistent
order.
customizationContext
- customization information such as preferred locales.webapp
- 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 number of characters and '?' matches any single character.limit
- the maximum result set size. Note the limit may be negative indicating a reverse sort order.
To retrieve all the records specify a limit of zero.
Note: some elements may be pruned because of entitlements.
DesktopDefinition
s no greater than limit
in size.
RemoteException
void deleteDesktopDefinition(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
Delete the DesktopDefinition
of the supplied desktop definition identifier.
deleteDesktopDefinitionWithCascade
, except that this method throws an
ObjectInUseException
if the desktop definition has current customizations defined.
customizationContext
- customization information such as preferred locales and desktopInstanceIddesktopDefinitionId
- the unique desktop definition identifier of the desktop to delete.
ObjectNotFoundException
- if there is no DesktopDefinition associated with desktopDefinitionId.
ObjectInUseException
- if this desktop definition is currently being used by desktop (user) instances.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
RemoteException
void deleteDesktopDefinitionWithCascade(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
Delete the DesktopDefinition
of the supplied desktop definition id and
all desktop instances associated with this definition.
customizationContext
- customization information such as preferred locales and desktopInstanceIddesktopDefinitionId
- the unique desktop definition identifier of the desktop to delete.
ObjectNotFoundException
- if there is no DesktopDefinition associated with desktopDefinitionId.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
RemoteException
void updateDesktopDefinition(CustomizationContext customizationContext, DesktopDefinition desktopDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
Update the persistent store for the supplied DesktopDefinition
. All attributes of the DesktopDefinition,
except template, are updated in the persistent store.
customizationContext
- customization information such as preferred locales and desktopInstanceIddesktopDefinition
- the object containing the new data for the desktop definition.
ObjectNotFoundException
- the DesktopDefinitionId
NotEntitledException
- if the caller does not have the required permissions to delete this object.
RemoteException
DesktopDefinition createDesktopDefinition(CustomizationContext customizationContext, DesktopDefinition desktopDefinition) throws RemoteException, MissingDataException, ObjectNotFoundException, NotEntitledException, DuplicateObjectException
Creates a new desktop definition in the persistent store. This definition may be used to create desktop instances later on.
customizationContext
- customization information such as preferred locales and desktopInstanceIddesktopDefinition
- the desktop definition object containing all the required data.
MissingDataException
- if some vital information is missing from the DesktopDefinition.
NotEntitledException
- if the caller does not have the required permissions to delete this object.
DuplicateObjectException
- if the portalPath and desktopPath combination already exist in the database
RemoteException
ObjectNotFoundException
DesktopDefinition createDesktopDefinition(CustomizationContext customizationContext, DesktopView desktopView, String webappName) throws RemoteException, MissingDataException, ObjectNotFoundException, NotEntitledException, ViewDisassemblerException, DuplicateObjectException, DuplicateDefinitionException
Create a new desktop definition in the persistent store from the given
view
. The view
is typically constructed via the
XmlDisassembler
.
customizationContext
- customization information such as preferred locales, username and request, and most
importantly disassemblerTemplateAction.desktopView
- desktop view that has all the necessary information to create a desktop definition.webappName
- the name of the webapp
MissingDataException
- If some vital information is missing from the DesktopVeiw.
NotEntitledException
- If the caller does not have the required permissions to create a desktop definition.
ViewDisassemblerException
- If unable to disassemble the given desktop view desktopView
.
typically caused by some bad markup names in the view.
DuplicateObjectException
- if the portalPath and desktopPath combination already exist in the database
DuplicateDefinitionException
- if a book or page with the same definition label already exist in the database.
RemoteException
ObjectNotFoundException
CustomizationContext.setDisassemblerTemplateAction(int)
,
XmlDisassembler
DesktopDefinition createDesktopTemplate(CustomizationContext customizationContext, DesktopView desktopView, String webappName, boolean isGlobal) throws RemoteException, MissingDataException, ObjectNotFoundException, NotEntitledException, ViewDisassemblerException, DuplicateObjectException, DuplicateDefinitionException
Create a new desktop template in the persistent store from the given
view
. The view
is typically constructed via the
XmlDisassembler
.
customizationContext
- customization information such as preferred locales, username and request, and most
importantly disassemblerTemplateAction.desktopView
- desktop view that has all the necessary information to create a desktop definition.webappName
- the name of the webappisGlobal
- true
if the desktop template should be marked global, false otherwise
MissingDataException
- If some vital information is missing from the DesktopVeiw.
NotEntitledException
- If the caller does not have the required permissions to create a desktop definition.
ViewDisassemblerException
- If unable to disassemble the given desktop view desktopView
.
typically caused by some bad markup names in the view.
DuplicateObjectException
- if the portalPath and desktopPath combination already exist in the database
DuplicateDefinitionException
- if a book or page with the same definition label already exist in the database.
RemoteException
ObjectNotFoundException
CustomizationContext.setDisassemblerTemplateAction(int)
,
XmlDisassembler
DesktopDefinition createDesktopTemplate(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, LocalizationResource templateLocalizationResource, PortalPath portalPath, DesktopPath desktopPath, boolean isGlobal) throws RemoteException, ObjectNotFoundException, IllegalArgumentException, NotEntitledException, DuplicateObjectException
customizationContext
- customization information such as preferred locales, username and requestdesktopDefinitionId
- DesktopDefinitionId of desktop to be used to create desktop templatetemplateLocalizationResource
- optional LocalizationResource
for the template being
created. If null LocalizationResource
from the underlying desktop will be usedportalPath
- portal path for the portal that the newly created template desktop will get assigned todesktopPath
- desktop path for the newly created template desktopisGlobal
- true
if this template is global
ObjectNotFoundException
- if no desktop matching desktopDefinitionId exists
IllegalArgumentException
- if input data is incorrect for e.g.: portal does not exist and
portalLocalizationResource is null
NotEntitledException
- if the caller does not have the required permissions to create a desktop definition
and a template
DuplicateObjectException
- if the desktopPath already exists in the database
RemoteException
DesktopDefinition createDesktopFromTemplate(CustomizationContext customizationContext, TemplateId templateId, LocalizationResource desktopLocalizationResource, PortalPath portalPath, DesktopPath desktopPath) throws RemoteException, ObjectNotFoundException, IllegalArgumentException, NotEntitledException, DuplicateObjectException, MissingDataException
TemplateTypeDefinition.TemplateType.DESKTOP
.
customizationContext
- customization information such as preferred locales, username and requesttemplateId
- unique identifier of the template to usedesktopLocalizationResource
- optional localization resource for desktop to be created when the template
is of type TemplateTypeDefinition.TemplateType.DESKTOP
. If null localization resource
from the desktop template will be usedportalPath
- portal path if a new PortalDefinition
needs to be created. May be null
in which case the new desktop will be created in the same portal as the templatedesktopPath
- desktopPath for the new DesktopDefinition
to be created
ObjectNotFoundException
- if template matching TemplateId
is not found
IllegalArgumentException
- if input data is invalid e.g. portalPath is specified without
a portalLocalizationResource
NotEntitledException
- if the caller does not have the required permissions to create a desktop definition
DuplicateObjectException
- if DesktopDefinition
matching desktopPath
already exists
MissingDataException
- if any input data is missing
RemoteException
SortableFilterablePagedResult<LocalizationResourceView> getVisibleDesktopLocalizationResources(CustomizationContext customizationContext, WebAppSearchCriteria criteria, int pageSize) throws RemoteException
customizationContext
- - a customization context with a request and locale defined. Only the first locale is used.criteria
- - the criteria for the search, including the name of the web application
where the requested resources livepageSize
- - number of results to retrieve per page
RemoteException
SortableFilterablePagedResult<DesktopDefinition> getDesktopDefinitions(CustomizationContext customizationContext, WebAppSearchCriteria criteria, int pageSize) throws RemoteException
customizationContext
- customization information such as preferred locales and http request.criteria
- used to specify the webapppageSize
- the number of item per page in the result.
RemoteException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |