Package com.atlassian.confluence.pages.actions

Interface PageAware

All Known Implementing Classes:
AbstractCreateAndEditPageAction, AbstractCreatePageAction, AbstractDiffPagesAction, AbstractEditPageAction, AbstractPageAction, AbstractPageAwareAction, AbstractPreviewPageAction, AbstractRemoveAttachmentAction, AbstractTemplatePageAction, AddCommentAction, AttachmentSearchAction, BreadcrumbAction, ChildrenAction, CopyPageAction, CreateBlogPostAction, CreatePageAction, CreatePageEntryAction, CreatePageFromTemplateAction, DiffPagesAction, DiffPagesByVersionAction, DownloadAllAttachmentsOnPageAction, EditBlogPostAction, EditCommentAction, EditNotificationsAction, EditorAction, EditPageAction, FindRestrictableEntitiesAction, GetPagePermissionsAction, ListWatchersAction, ManageWatchersAction, MoveAttachmentAction, MovePageDialogAction, PageChildrenAction, PageInfoAction, PageNotPermittedAction, PageVariablesAction, RemoveAttachedFileAction, RemoveAttachedFileVersionAction, RemoveCommentAction, RemovePageAction, RemovePagePermissionAction, ReorderPageDialogAction, RevertPageBackToVersionAction, SetPagePermissionsAction, ViewChangesSinceLastEditAction, ViewChangesSinceLastLoginAction, ViewDiffOfDraftAction, ViewPageAction, ViewPageAttachmentsAction, ViewPreviousVersionsAction
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

    Modifier and Type
    Method
    Description
    AbstractPage
    getPage()
     
    default boolean
    isEditPermissionRequired()
     
    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.

  • Method Details

    • 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

    • isEditPermissionRequired

      default boolean isEditPermissionRequired()
      Since:
      6.2.0