|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BookInstanceControl
A custom control interface used to interact with BookInstances.
Method Summary | |
---|---|
void |
addNavigable(com.bea.netuix.application.identifier.NavigableDefinitionId navigableToAddId,
int position,
com.bea.netuix.application.identifier.BookInstanceId parentBookId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Adds a child page or book (a navigable) to the specified book. |
com.bea.netuix.application.instance.BookInstance |
getBookInstance(com.bea.netuix.application.identifier.BookInstanceId id,
com.bea.portal.tools.common.ResourceContext context)
Returns the BookInstance of the specified book instance id. |
com.bea.netuix.application.view.BookView |
getBookView(com.bea.netuix.application.identifier.BookInstanceId id,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Returns the BookView of the specified book. |
void |
moveNavigable(com.bea.netuix.application.identifier.NavigableInstanceId navigableToMoveId,
int position,
com.bea.netuix.application.identifier.BookInstanceId fromParentBookId,
com.bea.netuix.application.identifier.BookInstanceId toParentBookId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Moves a child book or page (a navigable) within the specified book. |
void |
removeNavigable(com.bea.netuix.application.identifier.NavigableInstanceId navigableToRemoveId,
com.bea.netuix.application.identifier.BookInstanceId parentBookId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Removes a child book or page (a navigable) from the specified book. |
com.bea.netuix.application.identifier.BookInstanceId |
rename(String title,
com.bea.netuix.application.identifier.BookInstanceId parentBookId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Resets the title of the book instance. |
void |
setDefaultNavigable(com.bea.netuix.application.identifier.NavigableInstanceId navigableId,
com.bea.netuix.application.identifier.BookInstanceId bookId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Sets the default navigable for a book. |
com.bea.netuix.application.identifier.BookInstanceId |
updateThemeAndMenu(com.bea.netuix.application.identifier.MenuDefinitionId menuId,
com.bea.netuix.application.identifier.ThemeDefinitionId themeId,
com.bea.netuix.application.identifier.BookInstanceId bookId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Updates the appearance of a book. |
Method Detail |
---|
com.bea.netuix.application.view.BookView getBookView(com.bea.netuix.application.identifier.BookInstanceId id, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.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.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.instance.BookInstance getBookInstance(com.bea.netuix.application.identifier.BookInstanceId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.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.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.identifier.BookInstanceId updateThemeAndMenu(com.bea.netuix.application.identifier.MenuDefinitionId menuId, com.bea.netuix.application.identifier.ThemeDefinitionId themeId, com.bea.netuix.application.identifier.BookInstanceId bookId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.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
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
void addNavigable(com.bea.netuix.application.identifier.NavigableDefinitionId navigableToAddId, int position, com.bea.netuix.application.identifier.BookInstanceId parentBookId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException, com.bea.netuix.application.exception.MissingDataException, com.bea.netuix.application.exception.DuplicateObjectException, com.bea.netuix.application.exception.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.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.DuplicateObjectException
com.bea.netuix.application.exception.IllegalDependencyException
void moveNavigable(com.bea.netuix.application.identifier.NavigableInstanceId navigableToMoveId, int position, com.bea.netuix.application.identifier.BookInstanceId fromParentBookId, com.bea.netuix.application.identifier.BookInstanceId toParentBookId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException, com.bea.netuix.application.exception.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.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.exception.IllegalDependencyException
com.bea.netuix.application.identifier.BookInstanceId rename(String title, com.bea.netuix.application.identifier.BookInstanceId parentBookId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException, com.bea.netuix.application.exception.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.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.exception.MissingDataException
void removeNavigable(com.bea.netuix.application.identifier.NavigableInstanceId navigableToRemoveId, com.bea.netuix.application.identifier.BookInstanceId parentBookId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException, com.bea.netuix.application.exception.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.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.exception.MissingDataException
void setDefaultNavigable(com.bea.netuix.application.identifier.NavigableInstanceId navigableId, com.bea.netuix.application.identifier.BookInstanceId bookId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.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
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |