public abstract class

AbstractPage

extends SpaceContentEntityObject
implements HasLinkWikiMarkup
java.lang.Object
   ↳ com.atlassian.core.bean.EntityObject
     ↳ com.atlassian.confluence.core.ConfluenceEntityObject
       ↳ com.atlassian.confluence.core.AbstractVersionedEntityObject
         ↳ com.atlassian.confluence.core.AbstractLabelableEntityObject
           ↳ com.atlassian.confluence.core.ContentEntityObject
             ↳ com.atlassian.confluence.core.SpaceContentEntityObject
               ↳ com.atlassian.confluence.pages.AbstractPage
Known Direct Subclasses

Class Overview

Parent of the concrete Page and BlogPost classes

Summary

[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ContentEntityObject
From class com.atlassian.confluence.core.AbstractVersionedEntityObject
Public Constructors
AbstractPage()
Public Methods
void convertToHistoricalVersion()
Remove all data from the object that does not need to be saved by historical versions.
String getAttachmentUrlPath(Attachment attachment)
Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments).
String getAttachmentsUrlPath()
ContentEntityObject getContentEntityObject()
AbstractPage getLatestVersion()
Get the latest, current version of this versioned object.
AbstractPage getOriginalVersionPage()
if this page is a historical version, then this method returns the current/latest version of this page if this page is the latest version, then this returns null this method name should really be refactored to getCurrentVersionOfPage()
int getPreviousVersion()
Convenience method to get the immediately prior version since we can't perform arithmetic in velocity (assume that versions are sequential) Method is used in email templates where session is not available.
Collection<Searchable> getSearchableDependants()
List<Comment> getTopLevelComments()
String getUrlPath()
@Deprecated static boolean hasInvalidTitleCharacters(String title)
static boolean isValidPageTitle(String title)
@Deprecated static boolean isValidPageTitleCharacter(char c)
static boolean isValidTitleLength(String title)
void remove(PageManager pageManager)
Remove this page from the world.
void setOriginalVersionPage(AbstractPage originalVersionPage)
void setTitle(String title)
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.SpaceContentEntityObject
From class com.atlassian.confluence.core.ContentEntityObject
From class com.atlassian.confluence.core.AbstractLabelableEntityObject
From class com.atlassian.confluence.core.AbstractVersionedEntityObject
From class com.atlassian.confluence.core.ConfluenceEntityObject
From class com.atlassian.core.bean.EntityObject
From class java.lang.Object
From interface com.atlassian.bonnie.Searchable
From interface com.atlassian.confluence.content.Content
From interface com.atlassian.confluence.core.Addressable
From interface com.atlassian.confluence.core.ContentTypeAware
From interface com.atlassian.confluence.core.HasLinkWikiMarkup
From interface com.atlassian.confluence.core.Versioned
From interface com.atlassian.confluence.labels.EditableLabelable
From interface com.atlassian.confluence.labels.Labelable
From interface com.atlassian.confluence.spaces.Spaced
From interface java.lang.Comparable

Public Constructors

public AbstractPage ()

Public Methods

public void convertToHistoricalVersion ()

Remove all data from the object that does not need to be saved by historical versions. For versioned objects that are persisted, this includes removing associations with other persisted objects that may otherwise cause us to break the expected arity of the database relations.

When using Hibernate to persist versioned objects, take special care to null any field that might contain a Hibernate-persisted collection, as Hibernate does not allow two different persistent objects to refer to the same persisted collection at the same time.

public String getAttachmentUrlPath (Attachment attachment)

Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments). Generally you will want to call getUrlPath() instead of this method: if we ever implement view pages for individual attachments, that's the method that will be changed to point to them. The default implementation just returns the view page for this content.

Parameters
attachment one of this content's attachments
Returns
  • the path relative to the base url to view the attachment in the context of this content.

public String getAttachmentsUrlPath ()

public ContentEntityObject getContentEntityObject ()

public AbstractPage getLatestVersion ()

Get the latest, current version of this versioned object. If this object is the current version, return this object.

Returns
  • the current version of this object.

public AbstractPage getOriginalVersionPage ()

if this page is a historical version, then this method returns the current/latest version of this page if this page is the latest version, then this returns null this method name should really be refactored to getCurrentVersionOfPage()

public int getPreviousVersion ()

Convenience method to get the immediately prior version since we can't perform arithmetic in velocity (assume that versions are sequential) Method is used in email templates where session is not available. Hence we cannot load previousVersions to return a page object

public Collection<Searchable> getSearchableDependants ()

public List<Comment> getTopLevelComments ()

public String getUrlPath ()

@Deprecated public static boolean hasInvalidTitleCharacters (String title)

public static boolean isValidPageTitle (String title)

@Deprecated public static boolean isValidPageTitleCharacter (char c)

public static boolean isValidTitleLength (String title)

public void remove (PageManager pageManager)

Remove this page from the world. This method should sever any inverse relationships this page may have with other objects.

public void setOriginalVersionPage (AbstractPage originalVersionPage)

public void setTitle (String title)