|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPageDefinitionManager
This is the primary interface for performing persistent store operations on PageDefinitions
. 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.
"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 affecting a single desktop then use the PortalCustomizationManager
and make changes to the "Instances".
Method Summary | |
---|---|
PlaceableInstance |
addPlaceable(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId, PlaceableDefinitionId placeableDefinitionId, PlaceholderDefinitionId placeholderDefinitionId, int position) Create a new instance of a placeable (portlet or book) by placing the definition in a placeholder. |
PageDefinition |
createPageDefinition(CustomizationContext customizationContext, PageDefinition pageDefinition) Create a new page definition. |
PageDefinition |
createPageDefinition(CustomizationContext customizationContext, PageView pageView) Create a new page definition from an existing PageView -- generally intended for use after you've disassembled a .page file. |
void |
deletePageDefinition(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) Delete a page definition, but only if it is not used by other page instances. |
void |
deletePageDefinitionWithCascade(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) Delete a page definition and all page instances associated with this definition. |
void |
deletePageDefinitionWithReplacement(CustomizationContext customizationContext, PageDefinitionId deletePageDefinitionId, PageDefinitionId replacementPageDefinitionId) Delete an existing page definition and if it is in use replace its use with the supplied page definition. |
PageDefinition |
getPageDefinition(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) Getter for returning a single PageDefinition object given a supplied page definition identifier. |
PageDefinition |
getPageDefinition(CustomizationContext customizationContext, String pageDefinitionLabel, String webAppName) Getter for returning a single PageDefinition object given a supplied page definition label. |
SortableFilterablePagedResult<PageDefinition> |
getPageDefinitions(CustomizationContext customizationContext, PageSearchCriteria criteria, int pageSize) Get all the page definitions for the webapp as a paged object. |
PageDefinition[] |
getPageDefinitions(CustomizationContext customizationContext, String webapp) Getter for returning a list of all PageDefinitions scoped to the supplied webapp. |
PageDefinition[] |
getPageDefinitions(CustomizationContext customizationContext, String webapp, PageDefinitionId firstPageDefinitionId, int limit) Returns PageDefinition s in definitionId order, starting with the supplied definitionId and limiting the result set to size limit . |
SortableFilterablePagedResult<PageDefinition> |
getPagedPublicPageDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, int pageSize) Getter for returning a PagedResult of all PageDefinitions scoped to the supplied webapp and marked as public and not currently on the user's desktop. |
PageView |
getPageView(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) Getter for returning an immutable deep PageView. |
PlaceholderDefinition |
getPlaceholderDefinition(CustomizationContext ctx, PlaceholderDefinitionId id) Returns a PlaceholderDefinition given a PlaceholderDefinitionId . |
Placement |
getPlacement(CustomizationContext customizationContext, PlacementId placementId) Returns a Placement given a placementId . |
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) Getter for returning a list of all PageDefinitions marked as public and scoped to the supplied webapp and not currently on the caller's desktop. |
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageDefinitionId firstPageDefinitionId, int limit) Returns PageDefinition s in definitionId order scoped to the supplied webapp and marked as public and not currently on the users desktop, starting with the supplied definitionId and limiting the result set to size limit . |
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext, String webapp) Getter for returning a list of all PageDefinitions marked as public and scoped to the supplied webapp. |
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext, String webapp, BookDefinitionId bookDefinitionId) Getter for returning a list of all PageDefinitions marked as public and scoped to the supplied webapp and not currently on the supplied book. |
PageDefinition[] |
getPublicPageDefinitions(CustomizationContext customizationContext, String webapp, PageDefinitionId firstPageDefinitionId, int limit) Returns PageDefinition s in definitionId order marked as public and scoped to the supplied webapp, starting with the supplied definitionId and limiting the result set to size limit If fewer PageDefinition s exist than limit , then a smaller result set will be returned. |
PageView |
getShallowPageView(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) Getter for returning an immutable shallow PageView. |
SortableFilterablePagedResult<LocalizationResourceView> |
getVisiblePageLocalizationResources(CustomizationContext customizationContext, WebAppSearchCriteria criteria, int pageSize) Retrieve the LocalizationResourceViews for all visible pages for a given locale and webapp. |
SortableFilterablePagedResult<LocalizationResourceView> |
getVisiblePlaceholderLocalizationResources(CustomizationContext customizationContext, WebAppSearchCriteria criteria, int pageSize) Get visible placeholder definition localization resources for the given webapp. |
Placement |
movePlaceable(CustomizationContext customizationContext, PlacementId placementId, PlaceholderDefinitionId placeholderDefinitionId, int position) Move a placeable (book or portlet) definition from one placeholder to another. |
void |
removePlaceable(CustomizationContext customizationContext, PlacementId placementId) Remove a placeable from a page's placeholder. |
PageDefinition[] |
searchPublicPageDefinitions(CustomizationContext customizationContext, String webapp, String partialPageTitle, int limit) Search for public pages given the supplied search string. |
void |
updatePageDefinition(CustomizationContext customizationContext, PageDefinition pageDefinition) Update the page definition with the new data. |
void |
updatePageDefinitionNoDuplicates(CustomizationContext customizationContext, PageDefinition pageDefinition) Checks for duplicate page labels then updates the page definition with the new data. |
Method Detail |
---|
PageView getPageView(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException
Getter for returning an immutable deep PageView. The PageView
object, unlike the PageDefinition
or the PageInstance
objects contains a full set of references to all child pages, pages and so on. The PageView
object, however is immutable.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinitionId
- the unique pageDefinitionId.RemoteException
PageView getShallowPageView(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException
Getter for returning an immutable shallow PageView. The returned view object will be shallow in the sense that it will have no child book or portlet view arrays. However, you can lazily retrieve those by calling the paginated getPagedPlaceableViews method.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinitionId
- the unique pageDefinitionId.RemoteException
PageDefinition[] getPageDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
Getter for returning a list of all PageDefinitions
scoped to the supplied webapp.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.webapp
- the web application these page definitions are scoped to.PageDefinition
objects if they exist, otherwise, an empty array.RemoteException
PageDefinition
PageDefinition[] getPageDefinitions(CustomizationContext customizationContext, String webapp, PageDefinitionId firstPageDefinitionId, int limit) throws RemoteException
Returns PageDefinition
s in definitionId
order, starting with the supplied definitionId and limiting the result set to size limit
. If fewer PageDefinition
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 pageDefinitionId
. To retrieve from the end of the list and back specify null as the pageDefinitionId
and a negative limit
. To retrieve all the pageDefinitions in the database supply a limit of 0.
The implmentation has to ensure that repeated calls to this method return PageDefinition
s in a consistent order.
customizationContext
- customization information such as preferred locales.webapp
- the web application these page definitions are scoped to.firstPageDefinitionId
- 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.PageDefinition
s no greater than limit
in size.RemoteException
PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageDefinitionId firstPageDefinitionId, int limit) throws RemoteException
Returns PageDefinition
s in definitionId
order scoped to the supplied webapp and marked as public and not currently on the users desktop, starting with the supplied definitionId and limiting the result set to size limit
. If fewer PageDefinition
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 pageDefinitionId
. To retrieve from the end of the list and back specify null as the pageDefinitionId
and a negative limit
. To retrieve all the pageDefinitions in the database supply a limit of 0.
The implmentation has to ensure that repeated calls to this method return PageDefinition
s in a consistent order.
customizationContext
- customization information such as preferred localesdesktopDefinitionId
- you wish to add any of these page definitions to.firstPageDefinitionId
- 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.PageDefinition
objects if they exist, otherwise, an empty array.RemoteException
PageDefinition
PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, String webapp, PageDefinitionId firstPageDefinitionId, int limit) throws RemoteException
Returns PageDefinition
s in definitionId
order marked as public and scoped to the supplied webapp, starting with the supplied definitionId and limiting the result set to size limit
If fewer PageDefinition
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 pageDefinitionId
. To retrieve from the end of the list and back specify null as the pageDefinitionId
and a negative limit
. To retrieve all the pageDefinitions in the database supply a limit of 0.
The implmentation has to ensure that repeated calls to this method return PageDefinition
s in a consistent order.
customizationContext
- customization information such as preferred locales.webapp
- the web application these page definitions are scoped to.firstPageDefinitionId
- 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.PageDefinition
s no greater than limit
in size.RemoteException
PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, String webapp) throws RemoteException
Getter for returning a list of all PageDefinitions
marked as public and scoped to the supplied webapp.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.webapp
- the web application these page definitions are scoped to.PageDefinition
objects if they exist, otherwise, an empty array.RemoteException
PageDefinition
PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId) throws RemoteException
Getter for returning a list of all PageDefinitions
marked as public and scoped to the supplied webapp and not currently on the caller's desktop.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.desktopDefinitionId
- you wish to add any of these book definitions to.PageDefinition
objects if they exist, otherwise, an empty array.RemoteException
PageDefinition
PageDefinition[] getPublicPageDefinitions(CustomizationContext customizationContext, String webapp, BookDefinitionId bookDefinitionId) throws RemoteException
Getter for returning a list of all PageDefinitions
marked as public and scoped to the supplied webapp and not currently on the supplied book.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.webapp
- the web application these page definitions are scoped to.bookDefinitionId
- you wish to add any of these book definitions to.PageDefinition
objects if they exist, otherwise, an empty array.RemoteException
PageDefinition
SortableFilterablePagedResult<PageDefinition> getPagedPublicPageDefinitions(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, int pageSize) throws RemoteException
Getter for returning a PagedResult of all PageDefinitions
scoped to the supplied webapp and marked as public and not currently on the user's desktop.
customizationContext
- customization information such as preferred locales and desktopInstanceIddesktopDefinitionId
- you wish to add any of these page definitions to.PageDefinition
objects if they exist, otherwise, an empty array. The returned PagedResult is sortable and filterable on the fields "TITLE" and "DESCRIPTION", and supports these filter methods:
RemoteException
PageDefinition
PageDefinition[] searchPublicPageDefinitions(CustomizationContext customizationContext, String webapp, String partialPageTitle, int limit) throws RemoteException
Search for public pages given the supplied search string. Pages 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 PageDefinition
s in a consistent order.
customizationContext
- customization information such as preferred locales.webapp
- the web application these page definitions are scoped to.partialPageTitle
- the search string for page 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.PageDefinition
s no greater than limit
in size.RemoteException
PageDefinition getPageDefinition(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException
Getter for returning a single PageDefinition
object given a supplied page definition identifier.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinitionId
- the unique page definition identifier.PageDefinition
object fully populated and internationalized, otherwise, null>/code> if the object does not exist.
Throws
RemoteException
PageDefinition getPageDefinition(CustomizationContext customizationContext, String pageDefinitionLabel, String webAppName) throws RemoteException
Getter for returning a single PageDefinition
object given a supplied page definition label.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinitionLabel
- the unique page definition label.webAppName
- the webapp this page is scoped to.PageDefinition
object fully populated and internationalized, otherwise, null>/code> if the object does not exist.
Throws
RemoteException
void deletePageDefinition(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException, ObjectNotFoundException, ObjectInUseException, NotEntitledException
Delete a page definition, but only if it is not used by other page instances.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinitionId
- the id of the page definition to delete.ObjectNotFoundException
- if the pageDefinitionId is bogusObjectInUseException
- if page instances are currently using this page definitionNotEntitledException
- the caller is not entitled to perform this operation.RemoteException
deletePageDefinitionWithCascade(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.PageDefinitionId)
void deletePageDefinitionWithReplacement(CustomizationContext customizationContext, PageDefinitionId deletePageDefinitionId, PageDefinitionId replacementPageDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
Delete an existing page definition and if it is in use replace its use with the supplied page definition.
Note: all customization of the deleted page will be lost.customizationContext
- customization information such as preferred locales and desktopInstanceIddeletePageDefinitionId
- the definition id of the page to deletereplacementPageDefinitionId
- the definition id of the page to replace the deleted page.ObjectNotFoundException
- if the pageDefinitionId is bogus.NotEntitledException
- no entitlements for this operation.RemoteException
PageDefinition
void deletePageDefinitionWithCascade(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId) throws RemoteException, ObjectNotFoundException, NotEntitledException
Delete a page definition and all page instances associated with this definition.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinitionId
- the id of the page definition to delete.ObjectNotFoundException
- if the pageDefinitionId is bogusNotEntitledException
- the caller is not entitled to perform this operation.RemoteException
deletePageDefinition(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.PageDefinitionId)
void updatePageDefinition(CustomizationContext customizationContext, PageDefinition pageDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException
Update the page definition with the new data.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinition
- the page definition containing the new dataObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.RemoteException
NotEntitledException
void updatePageDefinitionNoDuplicates(CustomizationContext customizationContext, PageDefinition pageDefinition) throws RemoteException, ObjectNotFoundException, NotEntitledException, DuplicateObjectException
Checks for duplicate page labels then updates the page definition with the new data.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinition
- the page definition containing the new dataObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bad.RemoteException
NotEntitledException
DuplicateObjectException
PlaceableInstance addPlaceable(CustomizationContext customizationContext, PageDefinitionId pageDefinitionId, PlaceableDefinitionId placeableDefinitionId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException, IllegalDependencyException, DuplicateObjectException
customizationContext
- customization information such as preferred locales.pageDefinitionId
- the id of the page to place the placeable.placeableDefinitionId
- the abstract definition id of the placeable definition.placeholderDefinitionId
- the placehoder to place this placeable in.position
- the position in the placeholder to insert the placeholder.ObjectNotFoundException
- if the PageDefinitionId or the PlaceholderDefinition Id are bogusIllegalDependencyException
- adding the Placeable to the PageDefinition would cause a recursive dependancyMissingDataException
- the placeableDefinition is missing some vital data.NotEntitledException
- the caller is not entitled to perform this actionDuplicateObjectException
- if the navigable is a book and is already added to this pageRemoteException
void removePlaceable(CustomizationContext customizationContext, PlacementId placementId) throws RemoteException, ObjectNotFoundException, NotEntitledException
Remove a placeable from a page's placeholder. This operation will NOT delete the PageView Definition.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.placementId
-ObjectNotFoundException
- If the padeDefinitionId or the placeableInstanceId are bogus definition is in use by other instance.NotEntitledException
- the caller is not entitled to perform this actionRemoteException
Placement movePlaceable(CustomizationContext customizationContext, PlacementId placementId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, NotEntitledException
customizationContext
- customization information such as preferred locales & request.placementId
- the placement id of the placeables current placement within the pageplaceholderDefinitionId
- the new placehoder to place this placeable in.position
- the position in the placeholder to insert the placeable (starts with zero). After the moved placeable is given this position the entire position array must be normalized to ensure it is still zero-based and that it is contiguous with no missing positions. Therefore, the moved placeable will use this position and previously existing placeables at and beyond this position will have their position incremented by one. After the position incrementing, the positions will be normalized to shift the lowest position to a zero value and then shift any positions necessary to make them contiguous.ObjectNotFoundException
- if the PageDefinitionId or the PlaceholderDefinition Id are bogusNotEntitledException
- the caller is not entitled to perform this actionRemoteException
PageDefinition createPageDefinition(CustomizationContext customizationContext, PageDefinition pageDefinition) throws RemoteException, MissingDataException, NotEntitledException
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageDefinition
- the object containing the data to create the new page definition with.MissingDataException
- the pade definition object supplied is missing some vital data.NotEntitledException
- caller is not entitled to perform this actionRemoteException
PageDefinition createPageDefinition(CustomizationContext customizationContext, PageView pageView) throws RemoteException, NotEntitledException, DuplicateObjectException, DuplicateDefinitionException, ViewDisassemblerException
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.pageView
- the object containing the data to create the new page definition with.MissingDataException
- the pade definition object supplied is missing some vital data.NotEntitledException
- caller is not entitled to perform this actionViewDisassemblerException
- If unable to disassemble the given page view pageView
. typically caused by some bad markup names in the view.DuplicateDefinitionException
- if a book or page with the same definition label already exist in the database.RemoteException
DuplicateObjectException
CustomizationContext.setDisassemblerTemplateAction(int)
, XmlDisassembler
Placement getPlacement(CustomizationContext customizationContext, PlacementId placementId) throws RemoteException
Placement
given a placementId
. Returns null if no Placement
matching placementId
exists.placementId
- placementId for the placement being requestedRemoteException
PlaceholderDefinition getPlaceholderDefinition(CustomizationContext ctx, PlaceholderDefinitionId id) throws RemoteException
PlaceholderDefinition
given a PlaceholderDefinitionId
. Returns null if no such PlaceholderDefinition
exists.id
- the PlaceholderDefinitionId for the placemeholder being requestedRemoteException
SortableFilterablePagedResult<LocalizationResourceView> getVisiblePageLocalizationResources(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
- criteria for the search, including the name of the web application where the requested resources livepageSize
- - number of results to retrieve per pageRemoteException
SortableFilterablePagedResult<LocalizationResourceView> getVisiblePlaceholderLocalizationResources(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
- criteria for the search, including the name of the web application where the requested resources liveRemoteException
SortableFilterablePagedResult<PageDefinition> getPageDefinitions(CustomizationContext customizationContext, PageSearchCriteria 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
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.