|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface PageDefinitionControl
A custom control interface used to interact with PageDefinitions.
Method Summary | |
---|---|
void |
addPlaceableToPageDefinition(PlaceableDefinitionId placeableId,
int placeholder,
int position,
PageDefinitionId pageId,
ResourceContext context)
Adds an existing book or portlet to the specified page definition. |
PageDefinition |
createPageDefinition(String title,
String description,
LayoutDefinitionId layoutId,
boolean isHidden,
boolean isPublic,
String webapp,
ResourceContext context)
The method is used to create a page definition. |
PageDefinition |
createPageDefinition(String title,
String description,
LayoutDefinitionId layoutId,
boolean isPublic,
String webapp,
ResourceContext context)
The method is used to create a page definition. |
void |
deletePageDefinition(PageDefinitionId id,
boolean cascadeDelete,
ResourceContext context)
Deletes a PageDefinition This method attempts to clean up all related security policies on the deleted Page. |
PageDefinition |
getPageDefinition(PageDefinitionId id,
ResourceContext context)
Get a specific page definition object. |
PageDefinition |
getPageDefinition(String definitionLabel,
String webAppName,
ResourceContext context)
Getter for returning a single PageDefinition object given a supplied page
definition label. |
SortableFilterablePagedResult<PageDefinition> |
getPageDefinitions(int pageSize,
PageSearchCriteria criteria,
ResourceContext context)
Gets an Iterator of page definitions. |
PageView |
getPageView(PageDefinitionId id,
ResourceContext context)
Gets a deep immutable view of a page view. |
PageView |
getPageView(String definitionLabel,
String webAppName,
ResourceContext context)
Returns the PageView of the specified page. |
boolean |
isPlaceholderLocked(int placeholder,
PageDefinitionId pageId,
String webApp,
ResourceContext context)
Returns true if the placeholder has an update security policy on it. |
void |
movePlaceableInPageDefinition(PlaceableInstanceId placeableId,
int placeholder,
int position,
PageDefinitionId pageId,
ResourceContext context)
Used to change the position of a book or portlet in a page. |
void |
removePlaceableFromPageDefinition(PlaceableInstanceId placeableId,
PageDefinitionId pageId,
ResourceContext context)
Removes a book or portlet from a page definition. |
void |
removePlaceholderLock(int placeholder,
PageDefinitionId pageId,
String webApp,
ResourceContext context)
Removes the update security policy on a placeholder. |
void |
setPlaceholderLock(int placeholder,
PageDefinitionId pageId,
String webApp,
ResourceContext context)
Creates an update secuity policy on a placholder. |
void |
updatePageDefinitionLayout(LayoutDefinitionId layoutId,
PageDefinitionId pageId,
ResourceContext context)
Updates the layout of the page definition. |
void |
updatePageDefinitionTheme(ThemeDefinitionId themeId,
PageDefinitionId pageId,
boolean isHidden,
ResourceContext context)
Updates the page definition's theme. |
void |
updatePageDefinitionTheme(ThemeDefinitionId themeId,
PageDefinitionId pageId,
ResourceContext context)
Updates the page definition's theme. |
Method Detail |
---|
SortableFilterablePagedResult<PageDefinition> getPageDefinitions(int pageSize, PageSearchCriteria criteria, ResourceContext context) throws 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
ToolsException
PageDefinition getPageDefinition(PageDefinitionId id, ResourceContext context) throws ToolsException
id
- the ID of the page definition to retrievecontext
- the resource context
ToolsException
PageDefinition getPageDefinition(String definitionLabel, String webAppName, ResourceContext context) throws 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
ToolsException
- See Also
PageDefinition
PageView getPageView(PageDefinitionId id, ResourceContext context) throws ToolsException
id
- the ID of the page definition to retrieve a view ofcontext
- the resource context
ToolsException
PageView getPageView(String definitionLabel, String webAppName, ResourceContext context) throws 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.
ToolsException
void deletePageDefinition(PageDefinitionId id, boolean cascadeDelete, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, 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
ToolsException
NotEntitledException
ObjectNotFoundException
ObjectInUseException
PageDefinition createPageDefinition(String title, String description, LayoutDefinitionId layoutId, boolean isPublic, String webapp, ResourceContext context) throws NotEntitledException, MissingDataException, 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
NotEntitledException
MissingDataException
ToolsException
PageDefinition createPageDefinition(String title, String description, LayoutDefinitionId layoutId, boolean isHidden, boolean isPublic, String webapp, ResourceContext context) throws NotEntitledException, MissingDataException, ToolsException
title
- The title of the page definition.description
- The description of the page definition.layoutId
- The layout to assign the page definition.isHidden
- true if the page is to be hiddenisPublic
- true if the page is to be public.webapp
- The webApp assigned to the page.context
- the resource context
NotEntitledException
MissingDataException
ToolsException
void updatePageDefinitionLayout(LayoutDefinitionId layoutId, PageDefinitionId pageId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
layoutId
- The layout id to updatepageId
- the ID of the page.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updatePageDefinitionTheme(ThemeDefinitionId themeId, PageDefinitionId pageId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
themeId
- The new theme id.pageId
- the ID of the page.context
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updatePageDefinitionTheme(ThemeDefinitionId themeId, PageDefinitionId pageId, boolean isHidden, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
themeId
- The new theme id.pageId
- the ID of the page.isHidden
- is the page viewablecontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void addPlaceableToPageDefinition(PlaceableDefinitionId placeableId, int placeholder, int position, PageDefinitionId pageId, ResourceContext context) throws ToolsException, DuplicateObjectException, IllegalDependencyException, NotEntitledException, MissingDataException, 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
ToolsException
DuplicateObjectException
IllegalDependencyException
NotEntitledException
MissingDataException
ObjectNotFoundException
boolean isPlaceholderLocked(int placeholder, PageDefinitionId pageId, String webApp, ResourceContext context) throws ToolsException
placeholder
- The index of the placeholder on the page.pageId
- the ID of the pagewebApp
- the web application namecontext
- the resource context
ToolsException
void setPlaceholderLock(int placeholder, PageDefinitionId pageId, String webApp, ResourceContext context) throws 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
ToolsException
com.bea.p13n.entitlements.common.PolicyCreateException
com.bea.p13n.entitlements.common.PolicyExistsException
void removePlaceholderLock(int placeholder, PageDefinitionId pageId, String webApp, ResourceContext context) throws 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
ToolsException
com.bea.p13n.entitlements.common.PolicyRemoveException
com.bea.p13n.entitlements.common.PolicyNotFoundException
void movePlaceableInPageDefinition(PlaceableInstanceId placeableId, int placeholder, int position, PageDefinitionId pageId, ResourceContext context) throws ToolsException, NotEntitledException, 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
ToolsException
NotEntitledException
ObjectNotFoundException
void removePlaceableFromPageDefinition(PlaceableInstanceId placeableId, PageDefinitionId pageId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
placeableId
- The id of the book or portlet to remove from a page.pageId
- the ID of the pagecontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |