|
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 PageView
The page view represents a page and all its contents. Pages are used to display child Portlets and child Books in a specific layout in a browser. The standard term used to represent things that can be placed on a page is "Placeable". So both Book and Portlet extend Placeable. There is no theoretical limit to the number of placeables a page may contain.
"Views" are deep copy immutable objects. Unlike "Definitions" and "Instances" Views cannot be modified by the developer. An Instance or a Definition however can always be obtained from the view. The persistence APIs provide coarse grain and fine grain getters, but only fine grain setters. If you are interested in an object and all its children then retrieve the View. If you are only interested in the immediate object and don't care about its children then retrieve the Definition.
A page can be obtained in "deep" (the default) or "shallow" mode. In shallow mode, the child book, portlet, and placeable arrays are null. The child placeables can be retrieved as a PagedResult using getPagedPlaceableViews. In shallow mode, all of the methods for searching for child portlet or book views will return null, and count methods will return zero. The deep view is therefore more convenient to use, but the shallow view can be much lighter-weight. By default, PageViews are constructed in deep mode. There are specific methods in the portal persistence API to retrieve shallow page views. If a PageView was constructed in shallow mode, then any child BookView obtained by calling getPagedPlaceableViews will be shallow.
Field Summary |
---|
Fields inherited from interface com.bea.netuix.application.view.NavigableView |
---|
ALIGNMENT_LEFT, ALIGNMENT_RIGHT |
Fields inherited from interface com.bea.netuix.application.view.ProxiedEntityView |
---|
HAS_PROXY_INFO, NO_PROXY_INFO, NOT_AVAILABLE |
Method Summary | |
---|---|
int |
getBookCount() A convenience method for retrieving a total count of all the books in all the placeholders on this page. |
int |
getBookCountRecursive() Get the total number of child books of this parent. |
BookGroupId |
getBookGroupId() Getter for page's book group id. |
ChildView |
getBookOrPageViewRecursive(Id bookOrPageDefinitionId) Gets the child book or page with a given id, searching the entire tree of nested books and pages recursively |
BookView |
getBookView(BookInstanceId bookInstanceId) Retrieve a BookView matching the supplied database instance ID. |
BookView |
getBookView(String label) Retrieve a child BookView matching the supplied label. |
BookView |
getBookViewRecursive(BookDefinitionId bookDefinitionId) Retrieve a BookView matching the supplied database definition id, searching the entire tree of nested books. |
BookView |
getBookViewRecursive(BookInstanceId bookInstanceId) Retrieve a BookView matching the supplied database instance ID, searching the entire tree of nested books. |
BookView |
getBookViewRecursive(String bookDefinitionLabel) Retrieve a BookView matching the supplied database definition label, searching the entire tree of nested books. |
BookView[] |
getBookViews() Retrieves a list of all books in all placeholders on this page. |
LayoutView |
getLayoutView() Retrieve the child layout view associated with this page. |
LocalizationResourceView |
getLocalizationResourceView() The Localization resource contains the localized title and description for this look and feel. |
int |
getPageCountRecursive() Get the total number of child pages of this parent. |
PageDefinition |
getPageDefinition() Retrieve the associated PageDefinition from this Page View. |
PageDefinitionId |
getPageDefinitionId() Getter for page definition id. |
SortableFilterablePagedResult<PlaceableView> |
getPagedPlaceableViews(int pageSize, String resourcePrefix) A method for retrieving a paged list of all the placeables (books and portlets) in all the placeholders on this page. |
PageInstance |
getPageInstance() Retrieve the associated PageInstance from this Page View. |
PageInstanceId |
getPageInstanceId() Getter for page instance id. |
PageView |
getPageViewRecursive(PageDefinitionId pageDefinitionId) Retrieve a PageView matching the supplied database definition id, searching the entire tree of nested books. |
PageView |
getPageViewRecursive(PageInstanceId pageInstanceId) Retrieve a PageView matching the supplied database instance ID, searching the entire tree of nested books. |
PageView |
getPageViewRecursive(String pageDefinitionLabel) Retrieve a PageView matching the supplied database definition label, searching the entire tree of nested books. |
int |
getPlaceableCount() A convenience method for retieving a total count of all placeables (Books and Portlets) in all the placeholders on this page. |
PlaceableView |
getPlaceableView(String label) Return a PlaceableView (PortletView or BookView) matching the supplied label. |
PlaceableView[] |
getPlaceableViews() A method for retrieving an ordered list of all the placeables (books and portlets) in all the placeholders on this page. |
int |
getPlaceholderCount() A convenience method for retieving a count of placeholders in the current layout on this page. |
PlaceholderView[] |
getPlaceholderViews() A method for retrieving an ordered list of all the placeholders in this page. |
int |
getPortletCount() A convenience method for retrieving a total count of all the portlets in all the placeholders on this page. |
PortletView |
getPortletView(PortletInstanceId portletInstanceId) Retrieve a PortletView matching the supplied database instance ID. |
PortletView |
getPortletView(String instanceLabel) Retrieve a PortletView matching the supplied instance label. |
PortletView |
getPortletViewRecursive(PortletInstanceId portletInstanceId) Retrieve a PortletView matching the supplied database instance ID, searching the entire tree of nested books. |
PortletView |
getPortletViewRecursive(String portletInstanceLabel) Retrieve a PortletView matching the supplied portlet instance label, searching the entire tree starting at this page and recursing all nested books and pages. |
PortletView[] |
getPortletViews() Retrieves a list of all portlets in all placeholders on this page. |
PortletView[] |
getPortletViews(String definitionLabel) Retrieve an array of PortletViews matching the supplied definition label. |
String |
getWebAppName() Return the name of the webapp that this page is associated with. |
Methods inherited from interface com.bea.netuix.application.view.ParentView |
---|
getBookViewsRecursive, getPageView, getPageViewsRecursive |
Methods inherited from interface com.bea.netuix.application.view.NavigableView |
---|
getAlignment, getDefinitionLabel, getMenuPosition, getNavigableDefinition, getNavigableInstance, isDefaultPage, isHidden, isPublic |
Methods inherited from interface com.bea.netuix.application.view.View |
---|
getDescription, getTitle |
Methods inherited from interface com.bea.netuix.application.view.ThemedMarkupBasedView |
---|
getThemeView |
Methods inherited from interface com.bea.netuix.application.view.MarkupBasedView |
---|
getMarkupView |
Methods inherited from interface com.bea.netuix.application.view.View |
---|
getDescription, getTitle |
Methods inherited from interface com.bea.netuix.application.view.ProxiedEntityView |
---|
getProviderName, getProxiedEntityId, hasProxyInfo |
Method Detail |
---|
PageInstanceId getPageInstanceId()
Getter for page instance id. The instance id is the primary key value for the page instance in the PF_PAGE_INSTANCE table. A Page Definition may have many instance these instance are created when administrators or users customize their portal. A Page Definition always has at least one instance namely the "primary" instance.
PageDefinitionId getPageDefinitionId()
Getter for page definition id. The definition id is the primary key value for the page definition in the PF_PAGE_DEFINITION table. A Page Definition may have many instance these instance are created when administrators or users customize their portal. A Page Definition always has at least one instance namely the "primary" instance.
BookGroupId getBookGroupId()
Getter for page's book group id. The book group id represents a unique placement of a page on a book. Book may contain Pages just like they may contain Books. If this page is placed on a Book then this book group id represents the primary key value of the PF_BOOK_GROUP.BOOK_GROUP_ID value in the database. If this view was obtained directly and not from a parent view object then this value may be null.
getBookGroupId
in interface NavigableView
PageInstance getPageInstance()
Retrieve the associated PageInstance
from this Page View. Page Views are immutable but Page Instances and Book Definitions are not. Therefore it is often necessary to retrieve the instance from the view in order to update its values and then in turn call the persistence API.
PageDefinition getPageDefinition()
Retrieve the associated PageDefinition
from this Page View. Page Views are immutable but Instances and Definitions are not. Therefore it is often necessary to retrieve the definition from the view in order to update its values and then in turn call the persistence API.
LocalizationResourceView getLocalizationResourceView()
The Localization resource contains the localized title and description for this look and feel.
getLocalizationResourceView
in interface NavigableView
LayoutView getLayoutView()
Retrieve the child layout view associated with this page. It is actually the layout that contains all the child placeables.
PortletView[] getPortletViews()
Retrieves a list of all portlets in all placeholders on this page. For an ordered list see getPlaceableViews()
int getPortletCount()
A convenience method for retrieving a total count of all the portlets in all the placeholders on this page.
This method counts immediate children only.BookView[] getBookViews()
Retrieves a list of all books in all placeholders on this page. For an ordered list see getPlaceableViews()
int getBookCount()
A convenience method for retrieving a total count of all the books in all the placeholders on this page.
This method counts immediate children only.PlaceableView[] getPlaceableViews()
A method for retrieving an ordered list of all the placeables (books and portlets) in all the placeholders on this page. For just a list of placeables in a particular placeholder, see PlaceholderView.
SortableFilterablePagedResult<PlaceableView> getPagedPlaceableViews(int pageSize, String resourcePrefix) throws RemoteException
A method for retrieving a paged list of all the placeables (books and portlets) in all the placeholders on this page. For just a list of placeables in a particular placeholder see PlaceholderView.
getPlaceableViews
; if this view was built in deep mode then it will be more convenient to call that method. <p/> The returned PagedResult is sortable and filterable on the field "TITLE" and supports these filter methods:
RemoteException
int getPlaceableCount()
A convenience method for retieving a total count of all placeables (Books and Portlets) in all the placeholders on this page.
This method counts immediate children only.
PlaceholderView[] getPlaceholderViews()
A method for retrieving an ordered list of all the placeholders in this page. The order of the placeholders is determined by the placeholders getLocation()
index.
int getPlaceholderCount()
A convenience method for retieving a count of placeholders in the current layout on this page. This method counts immediate children only.
PortletView getPortletView(String instanceLabel)
instanceLabel
- the instance label of the portletPortletView getPortletView(PortletInstanceId portletInstanceId)
portletInstanceId
- the database instance ID of the portletPortletView[] getPortletViews(String definitionLabel)
definitionLabel
- the definition label of the portlets to findBookView getBookView(String label)
getBookView
in interface ParentView
label
-BookView getBookView(BookInstanceId bookInstanceId)
bookInstanceId
- the database instance ID of the bookBookView getBookViewRecursive(BookInstanceId bookInstanceId)
getBookViewRecursive
in interface ParentView
bookInstanceId
- the database instance ID of the bookBookView getBookViewRecursive(BookDefinitionId bookDefinitionId)
getBookViewRecursive
in interface ParentView
bookDefinitionId
- the deifnition id for the bookBookView getBookViewRecursive(String bookDefinitionLabel)
getBookViewRecursive
in interface ParentView
bookDefinitionLabel
- the deifnition label for the bookPageView getPageViewRecursive(PageInstanceId pageInstanceId)
getPageViewRecursive
in interface ParentView
pageInstanceId
- the database instance ID of the pagePageView getPageViewRecursive(PageDefinitionId pageDefinitionId)
getPageViewRecursive
in interface ParentView
pageDefinitionId
- the definition id of the page we are looking for.PageView getPageViewRecursive(String pageDefinitionLabel)
getPageViewRecursive
in interface ParentView
pageDefinitionLabel
- the definition label of the page we are looking for.ChildView getBookOrPageViewRecursive(Id bookOrPageDefinitionId)
bookOrPageDefinitionId
- (BookDefinitionId or PageDefinitionId) of the child book or page.int getBookCountRecursive()
Get the total number of child books of this parent. This method recursively counts all children. Note: only books can contain pages but pages can contain books.
int getPageCountRecursive()
Get the total number of child pages of this parent. This method recursively counts all children. Note: only books can contain pages but pages can contain books.
PortletView getPortletViewRecursive(PortletInstanceId portletInstanceId)
getPortletViewRecursive
in interface ParentView
portletInstanceId
- the database instance ID of the portletPortletView getPortletViewRecursive(String portletInstanceLabel)
Retrieve a PortletView matching the supplied portlet instance label, searching the entire tree starting at this page and recursing all nested books and pages.
getPortletViewRecursive
in interface ParentView
portletInstanceLabel
- the instance label of the portletPlaceableView getPlaceableView(String label)
Return a PlaceableView (PortletView or BookView) matching the supplied label. Note: portlets are searched first, so if a book and a portlet have the same label (which is possible) then the portlet view would be returned. If you need the BookView or PortletView explicitly then call getBookView(String definitionLabel)
or getPortletView(String instanceLabel)
.
label
- - instance label for portlets and definition label for booksString getWebAppName()
Return the name of the webapp that this page is associated with. All resources in the portal framework database are scoped to the webapp.
|
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.