|
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 BookDefinitionControl
A custom control interface used to interact with BookDefinitions.
Method Summary | |
---|---|
void |
addNavigable(com.bea.netuix.application.identifier.NavigableDefinitionId navigableToAddId,
int position,
com.bea.netuix.application.identifier.BookDefinitionId parentBookId,
com.bea.portal.tools.common.ResourceContext context)
Adds a child page or book (a navigable) to the specified book. |
com.bea.netuix.application.definition.BookDefinition |
createBookDefinition(String title,
String description,
com.bea.netuix.application.identifier.MenuDefinitionId menuDefinitionId,
boolean isPublic,
String webApp,
com.bea.portal.tools.common.ResourceContext context)
Creates a new BookDefinition based off the supplied
parameters. |
void |
deleteBookDefinition(com.bea.netuix.application.identifier.BookDefinitionId id,
boolean cascadeDelete,
com.bea.portal.tools.common.ResourceContext context)
Deletes the specified BookDefinition . |
com.bea.netuix.application.definition.BookDefinition |
getBookDefinition(com.bea.netuix.application.identifier.BookDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Returns the BookDefinition of the specified book definition
id. |
com.bea.netuix.application.definition.BookDefinition |
getBookDefinition(String definitionLabel,
String webAppName,
com.bea.portal.tools.common.ResourceContext context)
Getter for returning a single BookDefinition object given a supplied book
definition label. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.BookDefinition> |
getBookDefinitions(int pageSize,
com.bea.netuix.application.search.BookSearchCriteria criteria,
com.bea.portal.tools.common.ResourceContext context)
Returns a list of all the book definitions scoped to the web app. |
com.bea.netuix.application.view.BookView |
getBookView(com.bea.netuix.application.identifier.BookDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Returns the BookView of the specified book. |
com.bea.netuix.application.view.BookView |
getBookView(String definitionLabel,
String webAppName,
com.bea.portal.tools.common.ResourceContext context)
Returns the BookView of the specified book. |
com.bea.netuix.application.view.BookView |
getBookViewFromBookFile(String path,
com.bea.portal.tools.common.ResourceContext context)
|
void |
moveNavigable(com.bea.netuix.application.identifier.NavigableDefinitionId navigableToMoveId,
int position,
com.bea.netuix.application.identifier.BookDefinitionId parentBookId,
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.NavigableDefinitionId navigableToRemoveId,
com.bea.netuix.application.identifier.BookDefinitionId parentBookId,
com.bea.portal.tools.common.ResourceContext context)
Removes a child book or page (a navigable) from the specified book. |
void |
setDefaultNavigable(com.bea.netuix.application.identifier.NavigableDefinitionId navigableId,
com.bea.netuix.application.identifier.BookDefinitionId bookId,
com.bea.portal.tools.common.ResourceContext context)
Sets the default navigable for a book. |
void |
setTitleAndDescription(String title,
String description,
com.bea.netuix.application.identifier.BookDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Set the title and / or description for the specified book. |
com.bea.netuix.application.identifier.BookDefinitionId |
updateThemeAndMenu(com.bea.netuix.application.identifier.MenuDefinitionId menuId,
com.bea.netuix.application.identifier.ThemeDefinitionId themeId,
com.bea.netuix.application.identifier.BookDefinitionId bookId,
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.BookDefinitionId id, 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.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.view.BookView getBookView(String definitionLabel, String webAppName, 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.
definitionLabel
- the unique book definition identifier.webAppName
- the webapp this book is scoped to.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
void addNavigable(com.bea.netuix.application.identifier.NavigableDefinitionId navigableToAddId, int position, com.bea.netuix.application.identifier.BookDefinitionId parentBookId, 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 tocontext
- 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.NavigableDefinitionId navigableToMoveId, int position, com.bea.netuix.application.identifier.BookDefinitionId parentBookId, 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 bookparentBookId
- the ID of the book to move the navigable incontext
- 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
void removeNavigable(com.bea.netuix.application.identifier.NavigableDefinitionId navigableToRemoveId, com.bea.netuix.application.identifier.BookDefinitionId parentBookId, 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 fromcontext
- 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.NavigableDefinitionId navigableId, com.bea.netuix.application.identifier.BookDefinitionId bookId, 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.context
- 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.identifier.BookDefinitionId updateThemeAndMenu(com.bea.netuix.application.identifier.MenuDefinitionId menuId, com.bea.netuix.application.identifier.ThemeDefinitionId themeId, com.bea.netuix.application.identifier.BookDefinitionId bookId, 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 updatecontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.BookDefinition> getBookDefinitions(int pageSize, com.bea.netuix.application.search.BookSearchCriteria criteria, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
pageSize
- The page size for a page element inside the page iterator.criteria
- the criteria to use in the search.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.definition.BookDefinition getBookDefinition(com.bea.netuix.application.identifier.BookDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
BookDefinition
of the specified book definition
id.
id
- the ID of the book to retrieve.context
- the resource context.
BookDefintion
object.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.definition.BookDefinition getBookDefinition(String definitionLabel, String webAppName, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
Getter for returning a single BookDefinition
object given a supplied book
definition label.
definitionLabel
- the unique book definition identifier.webAppName
- the webapp this book is scoped to.context
- the resource context.
BookDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
- Throws
com.bea.portal.tools.common.exceptions.ToolsException
- See Also
BookDefinition
void deleteBookDefinition(com.bea.netuix.application.identifier.BookDefinitionId id, boolean cascadeDelete, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.ObjectInUseException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException
BookDefinition
.
Use the cascadeDelete parameter to either delete just the definition
(false), or to delete the defintions and all instances of in any
desktops (true).
This method attempts to clean up all related security
policies on the deleted Book. To achieve this, the current web app
MUST be set in the ResourceContext
via the setWebApp() method,
otherwise a NoWebAppFoundException
is thrown.
id
- the ID of the book to delete.cascadeDelete
- if true
, all instances in any desktops of the
specified definition are also deleted. If false
, only the
definition is deleted.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.ObjectInUseException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.definition.BookDefinition createBookDefinition(String title, String description, com.bea.netuix.application.identifier.MenuDefinitionId menuDefinitionId, boolean isPublic, String webApp, 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.MissingDataException
BookDefinition
based off the supplied
parameters. You may specify whether the book will be public or not.
Public books will be available to visitors via the visitor tools.
title
- the title of the BookDefinition
description
- the description of the BookDefinition
menuDefinitionId
- the menu to use for the
BookDefinition
. Pass in null
for no menu.isPublic
- whether or not to create the book as public.webApp
- the web application this book definition will be scoped to.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
void setTitleAndDescription(String title, String description, com.bea.netuix.application.identifier.BookDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.MissingDataException, com.bea.netuix.application.exception.ObjectNotFoundException
title
- The new title for the book definiton, or null
if the title
should remain unaltered.description
- the new description for the book definition, or null
if
the description should remain unaltered.id
- the ID of the book to update.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.view.BookView getBookViewFromBookFile(String path, com.bea.portal.tools.common.ResourceContext context) throws IOException, com.bea.netuix.application.transform.disassembler.XmlDisassemblerException, FileNotFoundException, com.bea.portal.tools.common.exceptions.ToolsException
path
- the .book or .pinc file.context
- the resource context
IOException
com.bea.netuix.application.transform.disassembler.XmlDisassemblerException
FileNotFoundException
com.bea.portal.tools.common.exceptions.ToolsException
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |