|
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 PageDefinitionControl
A custom control interface used to interact with PageDefinitions.
Method Summary | |
---|---|
void |
addPlaceableToPageDefinition(com.bea.netuix.application.identifier.PlaceableDefinitionId placeableId,
int placeholder,
int position,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
com.bea.portal.tools.common.ResourceContext context)
Adds an existing book or portlet to the specified page definition. |
com.bea.netuix.application.definition.PageDefinition |
createPageDefinition(String title,
String description,
com.bea.netuix.application.identifier.LayoutDefinitionId layoutId,
boolean isPublic,
String webapp,
com.bea.portal.tools.common.ResourceContext context)
The method is used to create a page definition. |
void |
deletePageDefinition(com.bea.netuix.application.identifier.PageDefinitionId id,
boolean cascadeDelete,
com.bea.portal.tools.common.ResourceContext context)
Deletes a PageDefinition This method attempts to clean up all related security policies on the deleted Page. |
com.bea.netuix.application.definition.PageDefinition |
getPageDefinition(com.bea.netuix.application.identifier.PageDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Get a specific page definition object. |
com.bea.netuix.application.definition.PageDefinition |
getPageDefinition(String definitionLabel,
String webAppName,
com.bea.portal.tools.common.ResourceContext context)
Getter for returning a single PageDefinition object given a supplied page
definition label. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PageDefinition> |
getPageDefinitions(int pageSize,
com.bea.netuix.application.search.PageSearchCriteria criteria,
com.bea.portal.tools.common.ResourceContext context)
Gets an Iterator of page definitions. |
com.bea.netuix.application.view.PageView |
getPageView(com.bea.netuix.application.identifier.PageDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Gets a deep immutable view of a page view. |
com.bea.netuix.application.view.PageView |
getPageView(String definitionLabel,
String webAppName,
com.bea.portal.tools.common.ResourceContext context)
Returns the PageView of the specified page. |
boolean |
isPlaceholderLocked(int placeholder,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
String webApp,
com.bea.portal.tools.common.ResourceContext context)
Returns true if the placeholder has an update security policy on it. |
void |
movePlaceableInPageDefinition(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId,
int placeholder,
int position,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
com.bea.portal.tools.common.ResourceContext context)
Used to change the position of a book or portlet in a page. |
void |
removePlaceableFromPageDefinition(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
com.bea.portal.tools.common.ResourceContext context)
Removes a book or portlet from a page definition. |
void |
removePlaceholderLock(int placeholder,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
String webApp,
com.bea.portal.tools.common.ResourceContext context)
Removes the update security policy on a placeholder. |
void |
setPlaceholderLock(int placeholder,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
String webApp,
com.bea.portal.tools.common.ResourceContext context)
Creates an update secuity policy on a placholder. |
void |
updatePageDefinitionLayout(com.bea.netuix.application.identifier.LayoutDefinitionId layoutId,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
com.bea.portal.tools.common.ResourceContext context)
Updates the layout of the page definition. |
void |
updatePageDefinitionTheme(com.bea.netuix.application.identifier.ThemeDefinitionId themeId,
com.bea.netuix.application.identifier.PageDefinitionId pageId,
com.bea.portal.tools.common.ResourceContext context)
Updates the page definition's theme. |
Method Detail |
---|
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PageDefinition> getPageDefinitions(int pageSize, com.bea.netuix.application.search.PageSearchCriteria criteria, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
pageSize
- The max size of one page in the result set.criteria
- the criteria to use in the search, including web application name.context
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.definition.PageDefinition getPageDefinition(com.bea.netuix.application.identifier.PageDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
id
- the ID of the page definition to retrievecontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.definition.PageDefinition getPageDefinition(String definitionLabel, String webAppName, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
Getter for returning a single PageDefinition
object given a supplied page
definition label.
definitionLabel
- the unique page definition identifier.webAppName
- the webapp this page is scoped to.context
- the resource context.
PageDefinition
object fully populated and internationalized, otherwise,
null>/code> if the object does not exist.
- Throws
com.bea.portal.tools.common.exceptions.ToolsException
- See Also
PageDefinition
com.bea.netuix.application.view.PageView getPageView(com.bea.netuix.application.identifier.PageDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
id
- the ID of the page definition to retrieve a view ofcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.view.PageView getPageView(String definitionLabel, String webAppName, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
PageView
of the specified page.
BookView's include the object's children unlike instances and
definitions.
definitionLabel
- the unique page definition identifier.webAppName
- the webapp this page is scoped to.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
void deletePageDefinition(com.bea.netuix.application.identifier.PageDefinitionId id, boolean cascadeDelete, 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.ObjectInUseException
ResourceContext
via the setWebApp() method, otherwise
a NoWebAppFoundException
is thrown.
id
- the ID of the page to deletecascadeDelete
- True enabled cascading deletes.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.exception.ObjectInUseException
com.bea.netuix.application.definition.PageDefinition createPageDefinition(String title, String description, com.bea.netuix.application.identifier.LayoutDefinitionId layoutId, boolean isPublic, String webapp, com.bea.portal.tools.common.ResourceContext context) throws com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.MissingDataException, com.bea.portal.tools.common.exceptions.ToolsException
title
- The title of the page definition.description
- The description of the page definition.layoutId
- The layout to assign the page definition.isPublic
- true if the page is to be public.webapp
- The webApp assigned to the page.context
- the resource context
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.portal.tools.common.exceptions.ToolsException
void updatePageDefinitionLayout(com.bea.netuix.application.identifier.LayoutDefinitionId layoutId, com.bea.netuix.application.identifier.PageDefinitionId pageId, 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
layoutId
- The layout id to updatepageId
- the ID of the page.context
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
void updatePageDefinitionTheme(com.bea.netuix.application.identifier.ThemeDefinitionId themeId, com.bea.netuix.application.identifier.PageDefinitionId pageId, 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
themeId
- The new theme id.pageId
- the ID of the page.context
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
void addPlaceableToPageDefinition(com.bea.netuix.application.identifier.PlaceableDefinitionId placeableId, int placeholder, int position, com.bea.netuix.application.identifier.PageDefinitionId pageId, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.DuplicateObjectException, com.bea.netuix.application.exception.IllegalDependencyException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.MissingDataException, com.bea.netuix.application.exception.ObjectNotFoundException
placeableId
- The id of the book or portlet to add.placeholder
- The index of the placeholder on the page.position
- The position of the placeable within the placeholder.pageId
- the ID of the page to add the placeable to.context
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.DuplicateObjectException
com.bea.netuix.application.exception.IllegalDependencyException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
boolean isPlaceholderLocked(int placeholder, com.bea.netuix.application.identifier.PageDefinitionId pageId, String webApp, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
placeholder
- The index of the placeholder on the page.pageId
- the ID of the pagewebApp
- the web application namecontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
void setPlaceholderLock(int placeholder, com.bea.netuix.application.identifier.PageDefinitionId pageId, String webApp, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.p13n.entitlements.common.PolicyCreateException, com.bea.p13n.entitlements.common.PolicyExistsException
placeholder
- The index of the placeholder on the page.pageId
- the ID of the pagewebApp
- the web application namecontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.p13n.entitlements.common.PolicyCreateException
com.bea.p13n.entitlements.common.PolicyExistsException
void removePlaceholderLock(int placeholder, com.bea.netuix.application.identifier.PageDefinitionId pageId, String webApp, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.p13n.entitlements.common.PolicyRemoveException, com.bea.p13n.entitlements.common.PolicyNotFoundException
placeholder
- The index of the placeholder on the page.pageId
- the ID of the pagewebApp
- the web application namecontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.p13n.entitlements.common.PolicyRemoveException
com.bea.p13n.entitlements.common.PolicyNotFoundException
void movePlaceableInPageDefinition(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId, int placeholder, int position, com.bea.netuix.application.identifier.PageDefinitionId pageId, 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
placeableId
- The id of the book or portlet to move.placeholder
- The index of the placeholder on the page.position
- The updated position of the book or portletpageId
- the ID of the pagecontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
void removePlaceableFromPageDefinition(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId, com.bea.netuix.application.identifier.PageDefinitionId pageId, 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
placeableId
- The id of the book or portlet to remove from a page.pageId
- the ID of the pagecontext
- 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 |