|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface BookInstanceControl
A custom control interface used to interact with BookInstances.
Method Summary | |
---|---|
void |
addNavigable(NavigableDefinitionId navigableToAddId,
int position,
BookInstanceId parentBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Adds a child page or book (a navigable) to the specified book. |
BookInstance |
getBookInstance(BookInstanceId id,
ResourceContext context)
Returns the BookInstance of the specified book instance id. |
BookView |
getBookView(BookInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Returns the BookView of the specified book. |
void |
moveNavigable(NavigableInstanceId navigableToMoveId,
int position,
BookInstanceId fromParentBookId,
BookInstanceId toParentBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Moves a child book or page (a navigable) within the specified book. |
void |
removeNavigable(NavigableInstanceId navigableToRemoveId,
BookInstanceId parentBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Removes a child book or page (a navigable) from the specified book. |
BookInstanceId |
rename(String title,
BookInstanceId parentBookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Resets the title of the book instance. |
void |
setDefaultNavigable(NavigableInstanceId navigableId,
BookInstanceId bookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Sets the default navigable for a book. |
BookInstanceId |
updateThemeAndMenu(MenuDefinitionId menuId,
ThemeDefinitionId themeId,
BookInstanceId bookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
boolean isHidden,
ResourceContext context)
Updates the appearance of a book. |
BookInstanceId |
updateThemeAndMenu(MenuDefinitionId menuId,
ThemeDefinitionId themeId,
BookInstanceId bookId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the appearance of a book. |
Method Detail |
---|
BookView getBookView(BookInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException
BookView
of the specified book.
BookView's include the object's children unlike instances and
definitions.
id
- the ID of the book to retrieve the view for.webApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context.
ToolsException
BookInstance getBookInstance(BookInstanceId id, ResourceContext context) throws ToolsException
BookInstance
of the specified book instance id.
id
- the ID of the book instance to retrievecontext
- the resource context.
BookInstance
object associated with the
BookInstanceId.
ToolsException
BookInstanceId updateThemeAndMenu(MenuDefinitionId menuId, ThemeDefinitionId themeId, BookInstanceId bookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
menuId
- the id of the menu to associate with the book. If null
,
no menu is associated with the book.themeId
- the id of the theme to associate with the book. If null
,
no theme is associated with the book.bookId
- the id of the book to updatewebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
BookInstanceId updateThemeAndMenu(MenuDefinitionId menuId, ThemeDefinitionId themeId, BookInstanceId bookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, boolean isHidden, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
menuId
- the id of the menu to associate with the book. If null
,
no menu is associated with the book.themeId
- the id of the theme to associate with the book. If null
,
no theme is associated with the book.bookId
- the id of the book to updatewebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathisHidden
- is the book viewablecontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void addNavigable(NavigableDefinitionId navigableToAddId, int position, BookInstanceId parentBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, MissingDataException, DuplicateObjectException, IllegalDependencyException
navigableToAddId
- the id of the page or book to addposition
- the position of the child within the bookparentBookId
- the ID of the book to add the navigable towebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context.
ToolsException
NotEntitledException
ObjectNotFoundException
MissingDataException
DuplicateObjectException
IllegalDependencyException
void moveNavigable(NavigableInstanceId navigableToMoveId, int position, BookInstanceId fromParentBookId, BookInstanceId toParentBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, IllegalDependencyException
navigableToMoveId
- the id of the page or book to moveposition
- the new position of the child within the bookfromParentBookId
- the ID of the book to move the navigable fromtoParentBookId
- the ID of the book to move the navigable towebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context.
ToolsException
NotEntitledException
ObjectNotFoundException
IllegalDependencyException
BookInstanceId rename(String title, BookInstanceId parentBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, MissingDataException
title
- the new title for the book instanceparentBookId
- the ID of the book to renamewebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context.
ToolsException
NotEntitledException
ObjectNotFoundException
MissingDataException
void removeNavigable(NavigableInstanceId navigableToRemoveId, BookInstanceId parentBookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, MissingDataException
navigableToRemoveId
- the id of the page or book to removeparentBookId
- the ID of the book to remove the navigable fromwebApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context.
ToolsException
NotEntitledException
ObjectNotFoundException
MissingDataException
void setDefaultNavigable(NavigableInstanceId navigableId, BookInstanceId bookId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
navigableId
- the id of the page or book that will be the defaultbookId
- the id of the book to set the default navigable for.webApp
- the webapp nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |