NavigableView
, PlaceableView
, ThemedMarkupBasedView
"Views" are deep copy immutable objects. Unlike "Definitions" and "Instances" Views cannot be modified by the developer. A Instance or a Definition however can always be obtained from the view. The persistence APIs provides course 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.
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.Related Topics
MarkupBasedView
, NavigableView
, PlaceableView
, Serializable
, ThemedMarkupBasedView
, View
Field Summary |
public static final short |
|
public static final short |
|
public static final short |
|
public static final short |
|
Fields from interface com.bea.netuix.application.view. |
|
Method Summary |
public int |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public short |
|
public |
|
public int |
|
public |
|
public |
|
public |
|
public |
|
public int |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Field Detail |
public static final short ORIENTATION_BOTTOM
public static final short ORIENTATION_LEFT
public static final short ORIENTATION_RIGHT
public static final short ORIENTATION_TOP
Method Detail |
public int getBookCount()
Get the number of child books of this book. This method counts immediate children only.
public 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.
public BookDefinitionId
getBookDefinitionId()
Getter for 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 instance these instance are created when administrators or users customize their portal. A Book Definition always has at least one instance namely the "primary" instance.
public BookGroupId
getBookGroupId()
Getter for 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 may not be placed on a book as it may be place on a page. Also, if this view was obtained directly and not from a parent view object then this value may also be null.
public 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.
public BookInstanceId
getBookInstanceId()
Getter for 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 instance these instance are created when administrators or users customize their portal. A Book Definition always has at least one instance namely the "primary" instance.
publicGets an immediate child book with a given label.BookView
getBookView(String
definitionLabel)
publicGets an immediate child book with a given instance ID.BookView
getBookView(BookInstanceId
bookInstanceId)
publicGets an immediate child book with a given definition Id.BookView
getBookView(BookDefinitionId
bookDefinitionId)
publicGets any child book with a given instance ID, searching the entire tree of nested books.BookView
getBookViewRecursive(BookInstanceId
bookInstanceId)
publicGets any child book with a given label, searching the entire tree of nested books.BookView
getBookViewRecursive(String
bookDefinitionLabel)
public BookView
[] getBookViews()
Get the child books of this book. Books can contain Books just like they can contain Pages. If this Book has child books then this method returns them. This method returns immediate children only.
public 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 even though this methods say get default Page.
public 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
public MenuView
getMenuView()
Get the child menu View class for this book. Menus are optional on a book so this may return null.
public int getNavigableCount()Get the number of child navigables (books or pages) of this book. This method counts immediate children only.
publicGets the child navigable (book or page) with a given label, searching only the immediate children.NavigableView
getNavigableView(String
definitionLabel)
publicGets the child navigable (book or page) with a given label, searching only the immediate children.NavigableView
getNavigableView(NavigableDefinitionId
navigableDefinitionId)
publicGets the child navigable (book or page) with a given label, searching only the immediate children.NavigableView
getNavigableView(NavigableInstanceId
navigableInstanceId)
public NavigableView
[] getNavigableViews()
Get the child navigables (books or pages) of this book. This method returns immediate children only.
The return array is sorted based on menu position.
public int getPageCount()Get the number of child pages of this book. This method counts immediate children only.
publicGets an immediate child page with a given label.PageView
getPageView(String
definitionLabel)
publicGets an immediate child page with a given instance ID. Returns null if no such page is found.PageView
getPageView(PageInstanceId
pageInstanceId)
publicGets an immediate child page with a given definition ID.PageView
getPageView(PageDefinitionId
pageDefinitionId)
publicGets the PageView with a given instance id, searching the entire tree of nested books.PageView
getPageViewRecursive(PageInstanceId
pageInstanceId)
publicGets the PageView with a given label, searching the entire tree of nested books.PageView
getPageViewRecursive(String
pageDefinitionLabel)
public PageView
[] getPageViews()
Get the child pages of this book. Books can contain Pages just like they can contain Books. If this Book has child pages then this method returns them. This method returns immediate children only.
public PlacementId
getPlacementId()
Getter for book's placement id. The placement id represents a unique placement of a book on a page. Pages may contain Books just like they may contain 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 may not be placed on a page as it may be place on another book or 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.
publicGets the PortletView with a given instance ID, searching the entire tree of nested books, pages, ....PortletView
getPortletViewRecursive(PortletInstanceId
portletInstanceId)
publicGets the PortletView with a given instance label, searching the entire tree of nested books.PortletView
getPortletViewRecursive(String
portletInstanceLabel)
public String
getWebAppName()
Return the name of the webapp that this book is associated with. All resources in the portal framework database
are scoped to the webapp.