com.atlassian.confluence.pages.actions
Interface PageAware
- All Known Implementing Classes:
- AbstractCreateAndEditPageAction, AbstractCreatePageAction, AbstractDiffPagesAction, AbstractEditAttachedFileAction, AbstractEditPageAction, AbstractFileAttachmentAction, AbstractPageAction, AbstractPageChangeAction, AbstractPreviewPageAction, AbstractTemplatePageAction, AddCommentAction, AddPageNotificationAction, ChildrenAction, CopyPageAction, CreateBlogPostAction, CreatePageAction, CreatePageEntryAction, DiffPagesAction, DiffPagesByVersionAction, DownloadAllAttachmentsOnPageAction, EditBlogPostAction, EditCommentAction, EditPageAction, ExportPageAction, ExportWordPageAction, GallerySlideshowAction, HandleNameConflictsAction, InsertImageInPageAction, MoveAttachmentAction, MovePageAction, PageInfoAction, PageNotPermittedAction, PageVariablesAction, RemoveAttachedFileAction, RemoveCommentAction, RemovePageAction, RemovePageNotificationAction, RemovePagePermissionAction, RevertPageBackToVersionAction, ViewChangesSinceLastEditAction, ViewChangesSinceLastLoginAction, ViewPageAction, ViewPageAttachmentsAction, ViewPreviousVersionsAction, ViewSourceAction
public interface PageAware
Indicates that an action may have a page set on it by the PageAwareInterceptor. Check the
PageAwareInterceptor
for parameters which will cause the Page to be set.
Method Summary |
AbstractPage |
getPage()
|
boolean |
isLatestVersionRequired()
If the action can only work on the most recent version of a page, this will cause the
interceptor to silently replace the version that it looks up with the most recent
version, if necessary. |
boolean |
isPageRequired()
If the action requires that the page be set before being run, then it should
return true to this method. |
boolean |
isViewPermissionRequired()
|
void |
setPage(AbstractPage page)
IOC method for setting the page on the action. |
getPage
AbstractPage getPage()
- Returns:
- page the page that the action worked on
setPage
void setPage(AbstractPage page)
- IOC method for setting the page on the action. This is called from the interceptor
- Parameters:
page
- the page that the action will be working on.
isPageRequired
boolean isPageRequired()
- If the action requires that the page be set before being run, then it should
return true to this method. If the action requires a page, but no page is available,
then the interceptor will automatically redirect to the 'pagenotfound' result
- Returns:
- true if the action requires a page in order to execute
isLatestVersionRequired
boolean isLatestVersionRequired()
- If the action can only work on the most recent version of a page, this will cause the
interceptor to silently replace the version that it looks up with the most recent
version, if necessary.
- Returns:
- true if the action requires the most recent version of a page
isViewPermissionRequired
boolean isViewPermissionRequired()
- Returns:
- true if the action requires a check on the view page level permissions on this page
Copyright © 2003-2008 Atlassian Pty Ltd. All Rights Reserved.