|
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 BookView
The book view represents a book and all its contents. Books aggregate a set of navigables. A navigable is either a book or a page, so books can contain pages but may also contain other books. There is no theoretical limit to the number of navigables a book 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 book can be obtained in "deep" (the default) or "shallow" mode. In shallow mode, the child book, page, and navigable arrays are null. The child navigables can be retrieved by a PagedResult using getPagedNavigableViews. In shallow mode, all of the methods for searching for child page 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, BookViews are constructed in deep mode. There are specific methods in the portal persistence API to retrieve shallow book views. If a BookView was constructed in shallow mode, then any child BookView or PageView obtained by calling getPagedNavigableViews will be shallow.
View
Field Summary | |
---|---|
static short |
ORIENTATION_BOTTOM
Constant enum to represent a book's menu location. |
static short |
ORIENTATION_LEFT
Constant enum to represent a book's menu location. |
static short |
ORIENTATION_RIGHT
Constant enum to represent a book's menu location. |
static short |
ORIENTATION_TOP
Constant enum to represent a book's menu location. |
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()
Get the number of child books of this book. |
BookDefinition |
getBookDefinition()
Retrieve the associated BookDefinition from this Book View. |
BookDefinitionId |
getBookDefinitionId()
Getter for the book definition id. |
BookGroupId |
getBookGroupId()
Getter for the book's book group id. |
BookInstance |
getBookInstance()
Retrieve the associated BookInstance from this Book View. |
BookInstanceId |
getBookInstanceId()
Getter for the book instance id. |
BookView |
getBookView(BookDefinitionId bookDefinitionId)
Gets an immediate child book with a given definition Id. |
BookView |
getBookView(BookInstanceId bookInstanceId)
Gets an immediate child book with a given instance ID. |
BookView |
getBookView(String definitionLabel)
Gets an immediate child book with a given label. |
BookView |
getBookViewRecursive(BookDefinitionId bookDefinitionId)
Gets any child book with a given definition id, searching the entire tree of nested books and pages. |
BookView |
getBookViewRecursive(BookInstanceId bookInstanceId)
Gets any child book with a given instance ID, searching the entire tree of nested books and pages. |
BookView |
getBookViewRecursive(String bookDefinitionLabel)
Gets any child book with a given label, searching the entire tree of nested books and pages. |
BookView[] |
getBookViews()
Get the child books of this book. |
String |
getDefaultPage()
Retrieve the definition label of the default page for this book. |
short |
getMenuOrientation()
Returns the menu's orientation. |
MenuView |
getMenuView()
Get the child menu View class for this book. |
int |
getNavigableCount()
Get the number of child navigables (books or pages) of this book. |
NavigableView |
getNavigableView(NavigableDefinitionId navigableDefinitionId)
Gets the child navigable (book or page) with a given label, searching only the immediate children and pages. |
NavigableView |
getNavigableView(NavigableInstanceId navigableInstanceId)
Gets the child navigable (book or page) with a given label, searching only the immediate children and pages. |
NavigableView |
getNavigableView(String definitionLabel)
Gets the child navigable (book or page) with a given label, searching only the immediate children and pages. |
NavigableView[] |
getNavigableViews()
Get the child navigables (books or pages) of this book. |
int |
getPageCount()
Get the number of child pages of this book. |
SortableFilterablePagedResult<NavigableView> |
getPagedNavigableViews(int pageSize,
String resourcePrefix)
Get the child navigables (books or pages) of this book. |
PageView |
getPageView(PageDefinitionId pageDefinitionId)
Gets an immediate child page with a given definition ID. |
PageView |
getPageView(PageInstanceId pageInstanceId)
Gets an immediate child page with a given instance ID. |
PageView |
getPageView(String definitionLabel)
Gets an immediate child page with a given label. |
PageView |
getPageViewRecursive(PageDefinitionId pageDefinitionId)
Gets the PageView with a given pageDefinitionId, searching the entire tree of nested books and pages. |
PageView |
getPageViewRecursive(PageInstanceId pageInstanceId)
Gets the PageView with a given instance id, searching the entire tree of nested books and pages. |
PageView |
getPageViewRecursive(String pageDefinitionLabel)
Gets the PageView with a given label, searching the entire tree of nested books and pages. |
PageView[] |
getPageViews()
Get the child pages of this book. |
PlacementId |
getPlacementId()
Getter for the book's placement id. |
PortletView |
getPortletViewRecursive(PortletInstanceId portletInstanceId)
Gets the PortletView with a given instance ID, searching the entire tree of nested books and pages. |
PortletView |
getPortletViewRecursive(String portletInstanceLabel)
Gets the PortletView with a given instance label, searching the entire tree of nested books and pages. |
String |
getWebAppName()
Return the name of the webapp that this book is associated with. |
Methods inherited from interface com.bea.netuix.application.view.ParentView |
---|
getBookViewsRecursive, getPageViewsRecursive |
Methods inherited from interface com.bea.netuix.application.view.NavigableView |
---|
getAlignment, getDefinitionLabel, getLocalizationResourceView, 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.PlaceableView |
---|
getDefinitionLabel, getLabel, getLocalizationResourceView, getPlaceableDefinition, getPlaceableInstance, getPlaceholderDefinitionId, getPlaceholderPosition |
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 |
Field Detail |
---|
static final short ORIENTATION_TOP
static final short ORIENTATION_LEFT
static final short ORIENTATION_RIGHT
static final short ORIENTATION_BOTTOM
Method Detail |
---|
BookInstanceId getBookInstanceId()
Getter for the book instance id. The instance id is the primary key value for the book instance in the PF_BOOK_INSTANCE table. A Book Definition may have many instances. These instance are created when administrators or users customize their portal. A Book Definition always has at least one instance namely the "primary" instance.
BookDefinitionId getBookDefinitionId()
Getter for the book definition id. The definition id is the primary key value for the book definition in the PF_BOOK_DEFINITION table. A Book Definition may have many instances. These instance are created when administrators or users customize their portal. A Book Definition always has at least one instance, namely the "primary" instance.
PlacementId getPlacementId()
Getter for the book's placement id. The placement id represents a unique placement of a book on a page. Pages may contain Books and Portlets. If this book is placed on a Page then this placement id represents the primary key value of the PF_PLACEMENT.PLACEMENT_ID value in the database. Note: this book might not have been placed on a page as it may be place on another book or may be the main book of the desktop. Also, if this view was obtained directly and not from a parent view object then this value may also be null.
getPlacementId
in interface PlaceableView
BookGroupId getBookGroupId()
Getter for the book's book group id. The book group id represents a unique placement of a book on a book. Books may contain Books just like they may contain Pages. If this book 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. Note: this book might not have been placed on a book as it may be placed on a page. Also, if this view was obtained directly and not from a parent view object then this value may also be null.
getBookGroupId
in interface NavigableView
BookInstance getBookInstance()
Retrieve the associated BookInstance
from this Book View. Book Views are immutable but
Instances and 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.
BookDefinition getBookDefinition()
Retrieve the associated BookDefinition
from this Book View. Book 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.
String getDefaultPage()
Retrieve the definition label of the default page for this book. It is important to note that Book can act like pages on a parent book so this method may retrieve the definition label of a book.
MenuView getMenuView()
Get the child menu View class for this book. Menus are optional on a book so this may return null.
short getMenuOrientation()
Returns the menu's orientation. The orientation is a hint to the book and menu skeleton to render the menu at the top, left, right or bottom of the book. Since this is only a hint to the book/menu skeleton, if the skeleton does not support it, it will have no effect.
ORIENTATION_TOP, ORIENTATION_LEFT, ORIENTATION_RIGHTT, ORIENTATION_BOTTOM
BookView[] getBookViews()
Get the child books of this book. This method returns immediate children only.
int getBookCount()
Get the number of child books of this book. This method counts immediate children only.
PageView[] getPageViews()
Get the child pages of this book. This method returns immediate children only.
int getPageCount()
NavigableView[] getNavigableViews()
SortableFilterablePagedResult<NavigableView> getPagedNavigableViews(int pageSize, String resourcePrefix) throws RemoteException
getNavigableViews
. You should call this
method if this view was created in shallow mode; otherwise it is more faster
and convenient to call getNavigableViews
.
The returned PagedResult is sortable and filterable on the field "TITLE" and supports these filter methods:
RemoteException
int getNavigableCount()
BookView getBookView(String definitionLabel)
getBookView
in interface ParentView
definitionLabel
- of the child we are looking for.
PageView getPageView(String definitionLabel)
getPageView
in interface ParentView
definitionLabel
- of the child we are looking for.
BookView getBookView(BookInstanceId bookInstanceId)
bookInstanceId
- of the child we are looking for.
BookView getBookView(BookDefinitionId bookDefinitionId)
bookDefinitionId
- of the child book we are looking for.
BookView getBookViewRecursive(BookInstanceId bookInstanceId)
getBookViewRecursive
in interface ParentView
bookInstanceId
- of the child book we are looking for.
BookView getBookViewRecursive(BookDefinitionId bookDefinitionId)
getBookViewRecursive
in interface ParentView
bookDefinitionId
- of the child we are looking for.
BookView getBookViewRecursive(String bookDefinitionLabel)
getBookViewRecursive
in interface ParentView
bookDefinitionLabel
- of the child we are looking for.
PageView getPageView(PageInstanceId pageInstanceId)
pageInstanceId
- of the child page we are looking for.
PageView getPageView(PageDefinitionId pageDefinitionId)
pageDefinitionId
- of the child page we are looking for.
PageView getPageViewRecursive(PageInstanceId pageInstanceId)
getPageViewRecursive
in interface ParentView
pageInstanceId
- of the child page we are looking for.
PageView getPageViewRecursive(PageDefinitionId pageDefinitionId)
getPageViewRecursive
in interface ParentView
pageDefinitionId
- of the child page we are looking for.
PageView getPageViewRecursive(String pageDefinitionLabel)
getPageViewRecursive
in interface ParentView
pageDefinitionLabel
- of the child page we are looking for.
PortletView getPortletViewRecursive(PortletInstanceId portletInstanceId)
getPortletViewRecursive
in interface ParentView
portletInstanceId
- of the child portlet we are looking for.
PortletView getPortletViewRecursive(String portletInstanceLabel)
getPortletViewRecursive
in interface ParentView
portletInstanceLabel
- of the child portlet we are looking for.
NavigableView getNavigableView(String definitionLabel)
definitionLabel
- of the child book or page.
NavigableView getNavigableView(NavigableDefinitionId navigableDefinitionId)
navigableDefinitionId
- (BookDefinitionId or PageDefinitionId) of the child book or page.
NavigableView getNavigableView(NavigableInstanceId navigableInstanceId)
navigableInstanceId
- (BookInstanceId or PageInstanceId) of the child book or page.
String getWebAppName()
|
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 |