ContentEntityObject (Atlassian Confluence 6.3.3 API)

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

All Implemented Interfaces:

com.atlassian.bonnie.Searchable, Content, Addressable, ContentTypeAware, Versioned, RelatableEntity, EditableLabelable, Labelable, Serializable, Cloneable, Comparable

Direct Known Subclasses:

Comment, Draft, GlobalDescription, PageContentEntityObject, PersonalInformation, SpaceContentEntityObject
```
public abstract class ContentEntityObject
extends AbstractLabelableEntityObject
implements com.atlassian.bonnie.Searchable, Comparable, Addressable, Content, RelatableEntity
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COLLABORATIVE_EDITING_UUID` Contains the global UUID at the time Confluence was last restarted.
`static String`	`CONFLUENCE_RECOVERY`
`static String`	`CONFLUENCE_RECOVERY_WITH_EXTERNAL_CHANGE`
`static String`	`CONTENT_RESTORED_SYNC_REV_SOURCE`
`static String`	`CREATED`
`static String`	`CURRENT`
`static String`	`DELETED`
`static String`	`DRAFT` Constant used in `contentStatus` to indicate that this object is a draft.
`static String`	`DUMMY_SYNC_REV`
`static String`	`LIMITED_MODE_SYNC_REV_SOURCE`
`static String`	`MODIFIED`
`static String`	`SHARE_ID` Constant used to store a ContentProperty that allows shared access.
`static String`	`SYNC_REV` Constant used to store the Synchrony revision as a ContentProperty.
`static String`	`SYNC_REV_SOURCE` Constant used to store the status of the Synchrony revision as a ContentProperty.
`static String`	`SYNCHRONY_ACK_SYNC_REV_SOURCE`
`static String`	`SYNCHRONY_RECOVERY`
`static String`	`SYNCHRONY_RECOVERY_WITH_EXTERNAL_CHANGE`
`static String`	`SYNCHRONY_SYNC_REV_SOURCE`

Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject
INITIAL_VERSION

Fields inherited from interface com.atlassian.confluence.content.Content
UNSET

Constructor Summary

Constructors
Modifier Constructor and Description

protected ContentEntityObject()

Constructors
Modifier	Constructor and Description
`protected`	`ContentEntityObject()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAttachment(Attachment attachment)`
`void`	`addComment(Comment comment)`
`void`	`addCustomContent(CustomContentEntityObject customContentEntityObject)`
`void`	`addOutgoingLink(OutgoingLink link)`
`void`	`addPermission(ContentPermission permission)` Adds a ContentPermission.
`void`	`addReferralLink(ReferralLink link)`
`void`	`addTrackbackLink(TrackbackLink link)`
`void`	`applyChildVersioningPolicy(Versioned versionToPromote, ObjectDao dao)` If `Versioned.getVersionChildPolicy(com.atlassian.confluence.api.model.content.ContentType)` specifies so, moves content from versionToPromote to this Versioned instance or makes no change.
`Object`	`clone()`
`int`	`compareTo(Object o)` Content entities are naturally ordered alphabetically by "comparison name", which depends on the entity (it's the title for pages, the parent page title for comments, etc.).
`void`	`convertToHistoricalVersion()` Remove all data from the object that does not need to be saved by historical versions.
`protected void`	`ensureAttachmentBelongsToContent(Attachment attachment)`
`boolean`	`equals(Object o)`
`Attachment`	`getAttachmentNamed(String fileName)`
`List<Attachment>`	`getAttachments()` Don't use it directly, use AttachmentManager.getAttachments(page) instead.
`String`	`getAttachmentsUrlPath()`
`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`	`getBodyAsString()` Convenience method that returns the String representation of the content.
`String`	`getBodyAsStringWithoutMarkup()`
`BodyContent`	`getBodyContent()` Gets the `BodyContent` object for this ContentEntityObject.
`BodyContent`	`getBodyContent(BodyType expectedBodyType)` Gets the `BodyContent` object for this ContentEntityObject or throws an UnsupportedOperationException if its body type is not the same as the supplied `expectedBodyType`.
`List<BodyContent>`	`getBodyContents()`
`String`	`getCollaborativeEditingUuid()`
`List<Comment>`	`getComments()`
`protected ContentEntityObject`	`getContainerContent()` Implementing classes wanting to be `Contained` in another CEO should implement the Contained interface and delegate to this method
`ContentEntityObject`	`getContentEntityObject()` Deprecated. since 5.7. Use `getEntity()`
`ContentId`	`getContentId()` Returns the `ContentId` for this entity object, if it implements `ContentConvertible`.
`ContentPermission`	`getContentPermission(String permissionType)` Deprecated. since 2.6 - use getContentPermissionSet
`ContentPermissionSet`	`getContentPermissionSet(String type)` Note, this method does not return ContentPermissions inherited from the Content's ancestry.
`String`	`getContentStatus()` Get the hibernate field for content status, distinguishing only draft/deleted/current status.
`ContentStatus`	`getContentStatusObject()` Get the api layer enum for content status, distinguishing CURRENT/HISTORICAL/DRAFT/TRASHED.
`BodyType`	`getDefaultBodyType()`
`String`	`getDisplayTitle()` Returns the display title.
`ContentEntityObject`	`getEntity()` Gets the ContentEntityObject that backs this piece of content.
`String`	`getExcerpt()`
`String`	`getIdAsString()`
`long`	`getLatestVersionId()`
`List<Attachment>`	`getLatestVersionsOfAttachments()` Don't use it directly, use AttachmentManager.getLatestVersionsOfAttachments(page) instead.
`String`	`getLowerTitle()`
`abstract String`	`getNameForComparison()` Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.
`Long`	`getOriginalVersionId()`
`List<OutgoingLink>`	`getOutgoingLinks()` An outgoing link is a link on this page to another confluence page. It could also link to a website URL These links are contained in the page content They are refreshed each time the page is updated (LinkManager.updateOutgoingLinks())
`List<ContentPermission>`	`getPermissions()` Deprecated. since 2.6 - use `getContentPermissionSet(String)`
`ContentProperties`	`getProperties()`
`List<ReferralLink>`	`getReferralLinks()`
`String`	`getRenderedVersionComment()`
`Collection<com.atlassian.bonnie.Searchable>`	`getSearchableDependants()`
`ContentSelector`	`getSelector()`
`String`	`getShareId()`
`String`	`getSynchronyRevision()`
`String`	`getSynchronyRevisionSource()`
`String`	`getTitle()`
`List<TrackbackLink>`	`getTrackbackLinks()`
`abstract String`	`getType()` An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
`ContentTypeEnum`	`getTypeEnum()`
`abstract String`	`getUrlPath()`
`UserAccessor`	`getUserAccessor()` Deprecated. since 4.0
`String`	`getVersionComment()`
`boolean`	`hasContentPermissions()`
`int`	`hashCode()`
`boolean`	`hasPermissions(String type)`
`boolean`	`isCurrent()` Does this content have "current" status? (non-trashed and non-draft)
`boolean`	`isDeleted()`
`boolean`	`isDraft()`
`boolean`	`isIndexable()` Content entity objects that are historical versions should not be indexed.
`boolean`	`isRecentlyUpdatedFor(com.atlassian.user.User user)` Deprecated. since 4.0. Use `PageManager.isPageRecentlyUpdatedForUser(com.atlassian.confluence.pages.Page, com.atlassian.user.User)` instead as this was only used for pages anyway.
`boolean`	`isUnpublished()`
`boolean`	`isVersionCommentAvailable()`
`void`	`removeAttachment(Attachment attachment)`
`void`	`removeComment(Comment comment)`
`void`	`removeContentPermissionSet(ContentPermissionSet set)` This method removes the given ContentPermissionSet from this CEO and disconnects the set from its owner.
`void`	`removeCustomContent(CustomContentEntityObject customContentEntityObject)`
`void`	`removeOutgoingLink(OutgoingLink link)`
`void`	`removeReferralLink(ReferralLink link)`
`void`	`removeTrackbackLink(TrackbackLink link)`
`protected void`	`replaceContentProperties(ContentProperties propertiesToClone)` Clones the supplied properties and sets these as the properties of the current ContentEntityObject.
`void`	`restore()` restores content from the trash
`protected void`	`restoreDependents()`
`void`	`setAttachments(List<Attachment> attachments)`
`void`	`setBodyAsString(String content)` Convenience method that sets the content of this ContentEntityObject.
`void`	`setBodyContent(BodyContent bodyContent)` Sets the `BodyContent` object for this ContentEntityObject.
`void`	`setBodyContents(List<BodyContent> bodyContents)`
`void`	`setCollaborativeEditingUuid(String uuid)`
`void`	`setComments(List<Comment> comments)`
`protected void`	`setContainerContent(ContentEntityObject container)`
`void`	`setContentPropertiesFrom(ContentEntityObject ceo)` Initialises the `ContentProperties` of this ContentEntityObject by performing a deep clone of the `ContentEntityObject` object's properties.
`void`	`setContentStatus(String contentStatus)` Set the hibernate field for content status, distinguishing only draft/deleted/current status.
`void`	`setOriginalVersion(Versioned originalVersion)` Set the current version of this object.
`protected void`	`setOriginalVersionId(Long originalVersionId)` For Hibernate
`void`	`setOutgoingLinks(List<OutgoingLink> outgoingLinks)`
`void`	`setReferralLinks(List<ReferralLink> referralLinks)`
`void`	`setShareId(String shareId)`
`void`	`setSynchronyRevision(String synchronyRevision)`
`void`	`setSynchronyRevisionSource(String synchronyRevisionSource)`
`void`	`setTitle(String title)`
`void`	`setTrackbackLinks(List<TrackbackLink> trackbackLinks)`
`void`	`setUserAccessor(UserAccessor userAccessor)` Deprecated. since 4.0
`void`	`setVersionComment(String versionComment)`
`boolean`	`sharedAccessAllowed(String shareId)` Deprecated. since 5.10
`boolean`	`sharedAccessAllowed(com.atlassian.user.User user)` Checks if this draft can be accessed by users other than the creator (shared access)
`PageContext`	`toPageContext()` When the content is rendered, what context is it being rendered in?
`String`	`toString()`
`void`	`trash()` places content in trash can
`protected void`	`trashDependents()`
`boolean`	`wasCreatedBy(com.atlassian.user.User user)`

Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject
addLabelling, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, isFavourite, removeLabelling, setLabellings

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject
getConfluenceRevision, getLatestVersion, getOriginalVersion, getVersion, getVersionChildPolicy, isLatestVersion, isNew, setVersion

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject
getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject
getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bonnie.Searchable
getId

Methods inherited from interface com.atlassian.confluence.core.Addressable
getId

Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable
getId, isPersistent

- Field Detail
  - CURRENT
```
public static final String CURRENT
```
    See Also:
    
    Constant Field Values
  - DELETED
```
public static final String DELETED
```
    See Also:
    
    Constant Field Values
  - CREATED
```
public static final String CREATED
```
    See Also:
    
    Constant Field Values
  - MODIFIED
```
public static final String MODIFIED
```
    See Also:
    
    Constant Field Values
  - DRAFT
```
public static final String DRAFT
```
    Constant used in contentStatus to indicate that this object is a draft.
    Drafts for existing objects use AbstractVersionedEntityObject.originalVersion to point to the object they are drafts of and, unless stated otherwise, there should be only one draft per object, which is shared between all users.
    Drafts for existing objects are considered automatically shared according to the permissions set, but drafts for new objects are considered private, so if a user is trying to access one of them it should be verified that is doing so with the proper share id in addition to permissions.
    
    See Also:
    
    SHARE_ID, Versioned.getLatestVersion(), Constant Field Values
  - SHARE_ID
```
public static final String SHARE_ID
```
    Constant used to store a ContentProperty that allows shared access.
    Used for sharing drafts.
    
    See Also:
    
    DRAFT, Constant Field Values
  - SYNC_REV
```
public static final String SYNC_REV
```
    Constant used to store the Synchrony revision as a ContentProperty.
    
    See Also:
    
    Constant Field Values
  - DUMMY_SYNC_REV
```
public static final String DUMMY_SYNC_REV
```
    See Also:
    
    Constant Field Values
  - SYNC_REV_SOURCE
```
public static final String SYNC_REV_SOURCE
```
    Constant used to store the status of the Synchrony revision as a ContentProperty.
    
    See Also:
    
    Constant Field Values
  - COLLABORATIVE_EDITING_UUID
```
public static final String COLLABORATIVE_EDITING_UUID
```
    Contains the global UUID at the time Confluence was last restarted.
    
    See Also:
    
    Constant Field Values
  - LIMITED_MODE_SYNC_REV_SOURCE
```
public static final String LIMITED_MODE_SYNC_REV_SOURCE
```
    See Also:
    
    Constant Field Values
  - SYNCHRONY_SYNC_REV_SOURCE
```
public static final String SYNCHRONY_SYNC_REV_SOURCE
```
    See Also:
    
    Constant Field Values
  - SYNCHRONY_ACK_SYNC_REV_SOURCE
```
public static final String SYNCHRONY_ACK_SYNC_REV_SOURCE
```
    See Also:
    
    Constant Field Values
  - CONTENT_RESTORED_SYNC_REV_SOURCE
```
public static final String CONTENT_RESTORED_SYNC_REV_SOURCE
```
    See Also:
    
    Constant Field Values
  - CONFLUENCE_RECOVERY
```
public static final String CONFLUENCE_RECOVERY
```
    See Also:
    
    Constant Field Values
  - CONFLUENCE_RECOVERY_WITH_EXTERNAL_CHANGE
```
public static final String CONFLUENCE_RECOVERY_WITH_EXTERNAL_CHANGE
```
    See Also:
    
    Constant Field Values
  - SYNCHRONY_RECOVERY
```
public static final String SYNCHRONY_RECOVERY
```
    See Also:
    
    Constant Field Values
  - SYNCHRONY_RECOVERY_WITH_EXTERNAL_CHANGE
```
public static final String SYNCHRONY_RECOVERY_WITH_EXTERNAL_CHANGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ContentEntityObject
```
protected ContentEntityObject()
```
- Method Detail
  - getContentEntityObject
```
@Deprecated
public ContentEntityObject getContentEntityObject()
```
    Deprecated. since 5.7. Use getEntity()
  - getType
```
public abstract String getType()
```
    An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
    This is a bit of a hack, but it saves heaps of code elsewhere, especially since we tend to get back these objects wrapped in all sorts of Hibernate CGLIB stuff.
    
    Specified by:
    
    getType in interface ContentTypeAware
    
    Returns:
    
    the content type
  - getTypeEnum
```
public ContentTypeEnum getTypeEnum()
```
  - getIdAsString
```
public String getIdAsString()
```
  - getDisplayTitle
```
public String getDisplayTitle()
```
    Returns the display title. Some entities don't have titles for identification. For example, personal information objects use the user's fullname. Override this method to provide a custom title.
    
    Specified by:
    
    getDisplayTitle in interface Addressable
    
    Returns:
    
    the display title
  - getUrlPath
```
public abstract String getUrlPath()
```
    Specified by:
    
    getUrlPath in interface Addressable
  - getAttachmentUrlPath
```
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 Attachment.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.
    
    Throws:
    
    IllegalArgumentException - if the attachment is not attached to this content
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface EditableLabelable
  - setTitle
```
public void setTitle(String title)
```
  - getLowerTitle
```
public String getLowerTitle()
```
  - getDefaultBodyType
```
public BodyType getDefaultBodyType()
```
  - getBodyContent
```
public BodyContent getBodyContent()
```
    Gets the BodyContent object for this ContentEntityObject. Although it appears that there may be a number of BodyContent objects attached to a ContentEntityObject, only one is ever used. If there are none currently attached, a new BodyContent object is created and returned. Any values set on the returned BodyContent will not be saved unless a call is made to setBodyContent(com.atlassian.confluence.core.BodyContent). Null is never returned.
    
    This method should not normally be called directly unless, you need to be able to handle different body types. Use getBodyAsString() as you should normally be expecting only one type.
    
    Returns:
    
    the BodyContent.
    
    See Also:
    
    getBodyContent(BodyType)
  - getBodyContent
```
public BodyContent getBodyContent(BodyType expectedBodyType)
```
    Gets the BodyContent object for this ContentEntityObject or throws an UnsupportedOperationException if its body type is not the same as the supplied expectedBodyType.
    
    This method should not normally be called directly unless, you need to be able to handle different body types. Use getBodyAsString() and getBodyAsString() as you should normally be expecting only one type.
    
    Parameters:
    
    expectedBodyType - that can be handled by the caller.
    
    Returns:
    
    the BodyContent.
    
    Throws:
    
    UnsupportedOperationException - if the BodyType of the content is not the expectedBodyType.
    
    See Also:
    
    getBodyContent()
  - setBodyContent
```
public void setBodyContent(BodyContent bodyContent)
```
    Sets the BodyContent object for this ContentEntityObject.
    
    This method should not normally be called directly unless, you need to be able to handle different body types. Use setBodyAsString(java.lang.String) as you should normally be expecting only one type.
    
    Parameters:
    
    bodyContent - to be set. If the supplied bodyContent or its body are null, the list of body contents are cleared.
  - getBodyAsString
```
public String getBodyAsString()
```
    Convenience method that returns the String representation of the content.
    
    Returns:
    
    the content.
    
    Throws:
    
    UnsupportedOperationException - if the BodyType of the content is not the normal type (by default BodyType#XHTML) used by this ContentEntityObject.
  - setBodyAsString
```
public void setBodyAsString(String content)
```
    Convenience method that sets the content of this ContentEntityObject.
    
    Parameters:
    
    content - the String representation of the content.
    
    Throws:
    
    UnsupportedOperationException - if the BodyType of the content is not the normal type (by default BodyType#XHTML) used by this ContentEntityObject.
  - getBodyContents
```
public List<BodyContent> getBodyContents()
```
  - setBodyContents
```
public void setBodyContents(List<BodyContent> bodyContents)
```
  - getOutgoingLinks
```
public List<OutgoingLink> getOutgoingLinks()
```
    An outgoing link is a link on this page to another confluence page.
    It could also link to a website URL
    These links are contained in the page content
    They are refreshed each time the page is updated (LinkManager.updateOutgoingLinks())
    
    Returns:
    
    List of OutgoingLinks
  - setOutgoingLinks
```
public void setOutgoingLinks(List<OutgoingLink> outgoingLinks)
```
  - addOutgoingLink
```
public void addOutgoingLink(OutgoingLink link)
```
  - removeOutgoingLink
```
public void removeOutgoingLink(OutgoingLink link)
```
  - getReferralLinks
```
public List<ReferralLink> getReferralLinks()
```
  - setReferralLinks
```
public void setReferralLinks(List<ReferralLink> referralLinks)
```
  - addReferralLink
```
public void addReferralLink(ReferralLink link)
```
  - removeReferralLink
```
public void removeReferralLink(ReferralLink link)
```
  - getTrackbackLinks
```
public List<TrackbackLink> getTrackbackLinks()
```
  - setTrackbackLinks
```
public void setTrackbackLinks(List<TrackbackLink> trackbackLinks)
```
  - addTrackbackLink
```
public void addTrackbackLink(TrackbackLink link)
```
  - removeTrackbackLink
```
public void removeTrackbackLink(TrackbackLink link)
```
  - setOriginalVersion
```
public void setOriginalVersion(Versioned originalVersion)
```
    Description copied from interface: Versioned
    
    Set the current version of this object. After this method is called, this object will become an historical version of the object passed in.
    
    Specified by:
    
    setOriginalVersion in interface Versioned
    
    Overrides:
    
    setOriginalVersion in class AbstractVersionedEntityObject
    
    Parameters:
    
    originalVersion - the current version of this object.
  - convertToHistoricalVersion
```
public void convertToHistoricalVersion()
```
    Description copied from interface: Versioned
    
    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.
    
    Specified by:
    
    convertToHistoricalVersion in interface Versioned
    
    Overrides:
    
    convertToHistoricalVersion in class AbstractVersionedEntityObject
  - applyChildVersioningPolicy
```
public void applyChildVersioningPolicy(Versioned versionToPromote,
                                       ObjectDao dao)
```
    Description copied from interface: Versioned
    
    If Versioned.getVersionChildPolicy(com.atlassian.confluence.api.model.content.ContentType) specifies so, moves content from versionToPromote to this Versioned instance or makes no change.
    
    Specified by:
    
    applyChildVersioningPolicy in interface Versioned
    
    Overrides:
    
    applyChildVersioningPolicy in class AbstractVersionedEntityObject
    
    Parameters:
    
    versionToPromote - the new version of the current instance that we're getting the children from
    
    dao - dao used to delete dangling contained content
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class com.atlassian.core.bean.EntityObject
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.atlassian.core.bean.EntityObject
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getNameForComparison
```
public abstract String getNameForComparison()
```
    Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.
  - compareTo
```
public final int compareTo(Object o)
```
    Content entities are naturally ordered alphabetically by "comparison name", which depends on the entity (it's the title for pages, the parent page title for comments, etc.).
    If the comparison names are identical, we fall back on creation dates. This ensures, for example, that comments are always listed after the pages they are contained in, and in posting order.
    Note also: comparison does NOT agree with equals(). This makes using content entities within sets a little dangerous, but the chances of two things with the exact same name being created on exactly the same millisecond is probably pretty low.
    
    Specified by:
    
    compareTo in interface Comparable
  - getSearchableDependants
```
public Collection<com.atlassian.bonnie.Searchable> getSearchableDependants()
```
    Specified by:
    
    getSearchableDependants in interface com.atlassian.bonnie.Searchable
  - toPageContext
```
public final PageContext toPageContext()
```
    When the content is rendered, what context is it being rendered in?
  - isRecentlyUpdatedFor
```
@Deprecated
public boolean isRecentlyUpdatedFor(com.atlassian.user.User user)
```
    Deprecated. since 4.0. Use PageManager.isPageRecentlyUpdatedForUser(com.atlassian.confluence.pages.Page, com.atlassian.user.User) instead as this was only used for pages anyway.
    
    Returns true if the page has been created or modified since the user last logged in. If the user has no last login time, returns false. For an anonymous user returns false.
    
    Parameters:
    
    user -
    
    Returns:
    
    true if the page has been created or modified since the user's last login, false otherwise
  - isIndexable
```
public boolean isIndexable()
```
    Content entity objects that are historical versions should not be indexed.
    
    Specified by:
    
    isIndexable in interface com.atlassian.bonnie.Searchable
  - getPermissions
```
@Deprecated
public List<ContentPermission> getPermissions()
```
    Deprecated. since 2.6 - use getContentPermissionSet(String)
    
    Get all the permissions that apply to this content. Please do not modify the contents of this list!
    
    Returns:
    
    a list of all the permissions that apply to this content.
  - getContentPermission
```
@Deprecated
public ContentPermission getContentPermission(String permissionType)
```
    Deprecated. since 2.6 - use getContentPermissionSet
    
    Gives back the first content permission of a specific type. Returns only the permission if it is set on this object and not inherited. Returns null if no permission can't be found.
    Synchronized, as otherwise it was creating timing issues during the multi-threaded re-indexing.
    
    Returns:
    
    ContentPermission
  - sharedAccessAllowed
```
@Deprecated
public boolean sharedAccessAllowed(String shareId)
```
    Deprecated. since 5.10
    
    Checks if this draft can be accessed by users other than the creator (shared access)
    IMPORTANT NOTE: if shared access is disallowed it prevails over permissions (only creator has access), BUT if it is allowed normal permissions still need to be checked
    Drafts for existing objects are considered automatically shared according to the permissions set, but drafts for new objects are considered private, so if a user if trying to access one of them it should be verified that is doing so with the proper share id in addition to permissions.
    
    Parameters:
    
    shareId - Optional. Used to check for access if needed
    
    Returns:
    
    true if this draft can be accessed given a share id, false otherwise
    
    See Also:
    
    TODO: delete this method after 6.0
  - getContentStatusObject
```
public ContentStatus getContentStatusObject()
```
    Get the api layer enum for content status, distinguishing CURRENT/HISTORICAL/DRAFT/TRASHED.
    Important: this has different semantics from the hibernate field getContentStatus(), because it takes into account historical status, and uses different strings for some values.
    
    Returns:
    
    the API ContentStatus for this content, distinguishing CURRENT/HISTORICAL/DRAFT/TRASHED
    
    See Also:
    
    for the hibernate field value, different semantics
  - getContentStatus
```
public String getContentStatus()
```
    Get the hibernate field for content status, distinguishing only draft/deleted/current status.
    Important: this is not the same as the string value of the api getContentStatusObject(), because that one takes into account historical status, and uses different strings for some values.
    
    This method does NOT distinguish current and historical versions. Both will return "current". See AbstractVersionedEntityObject.isLatestVersion() to distinguish them.
    
    Returns:
    
    the hibernate field value, distinguishing only CURRENT, DRAFT, DELETED.
    
    See Also:
    
    for the API enum, different semantics
  - setContentStatus
```
public void setContentStatus(String contentStatus)
```
    Set the hibernate field for content status, distinguishing only draft/deleted/current status.
    Important: this is not the same as the string value of the api getContentStatusObject(), because that one takes into account historical status, and uses different strings for some values.
    
    This method does NOT distinguish current and historical versions. Both use "current". See AbstractVersionedEntityObject.isLatestVersion() to distinguish them.
    
    Parameters:
    
    contentStatus - the hibernate field value, CURRENT, DRAFT, DELETED.
    
    See Also:
    
    for the API enum, different semantics
  - isCurrent
```
public boolean isCurrent()
```
    Does this content have "current" status? (non-trashed and non-draft)
    This method does NOT distinguish current and historical versions. Both will return true. See AbstractVersionedEntityObject.isLatestVersion() to distinguish them.
    
    Returns:
    
    true if the content is live, i.e. not trashed and not a draft
    
    See Also:
    
    AbstractVersionedEntityObject.isLatestVersion()
  - isDeleted
```
public boolean isDeleted()
```
  - isDraft
```
public boolean isDraft()
```
  - sharedAccessAllowed
```
public boolean sharedAccessAllowed(com.atlassian.user.User user)
```
    Checks if this draft can be accessed by users other than the creator (shared access)
    IMPORTANT NOTE: if shared access is disallowed it prevails over permissions (only creator has access), BUT if it is allowed normal permissions still need to be checked
    Drafts for existing objects are considered automatically shared according to the permissions set, but drafts that have never been published are considered private even without permissions set, so if a user if trying to access one of them it should be verified that is doing so with the proper share id in addition to permissions.
    
    Parameters:
    
    user - User to check
    
    Returns:
    
    true if this draft can be accessed given a share id, false otherwise
    
    See Also:
    
    SHARE_ID, SharedAccessInterceptor, AbstractCreateAndEditPageAction.hasDraftPermission()
  - getShareId
```
public String getShareId()
```
    See Also:
    
    SHARE_ID
  - setShareId
```
public void setShareId(String shareId)
```
    See Also:
    
    SHARE_ID
  - getSynchronyRevision
```
public String getSynchronyRevision()
```
    See Also:
    
    SYNC_REV
  - setSynchronyRevision
```
public void setSynchronyRevision(String synchronyRevision)
```
    See Also:
    
    SYNC_REV
  - getSynchronyRevisionSource
```
public String getSynchronyRevisionSource()
```
    See Also:
    
    SYNC_REV_SOURCE
  - setSynchronyRevisionSource
```
public void setSynchronyRevisionSource(String synchronyRevisionSource)
```
    See Also:
    
    SYNC_REV_SOURCE
  - getCollaborativeEditingUuid
```
public String getCollaborativeEditingUuid()
```
    See Also:
    
    COLLABORATIVE_EDITING_UUID
  - setCollaborativeEditingUuid
```
public void setCollaborativeEditingUuid(String uuid)
```
    See Also:
    
    COLLABORATIVE_EDITING_UUID
  - isUnpublished
```
public boolean isUnpublished()
```
  - wasCreatedBy
```
public boolean wasCreatedBy(com.atlassian.user.User user)
```
  - trash
```
public void trash()
```
    places content in trash can
  - trashDependents
```
protected void trashDependents()
```
  - restore
```
public void restore()
```
    restores content from the trash
  - restoreDependents
```
protected void restoreDependents()
```
  - getAttachments
```
public List<Attachment> getAttachments()
```
    Don't use it directly, use AttachmentManager.getAttachments(page) instead.
    
    This also includes trashed items.
  - getLatestVersionsOfAttachments
```
public List<Attachment> getLatestVersionsOfAttachments()
```
    Don't use it directly, use AttachmentManager.getLatestVersionsOfAttachments(page) instead.
    
    This does not include trashed items.
  - setAttachments
```
public void setAttachments(List<Attachment> attachments)
```
  - addAttachment
```
public void addAttachment(Attachment attachment)
```
  - removeAttachment
```
public void removeAttachment(Attachment attachment)
```
  - getBodyAsStringWithoutMarkup
```
public String getBodyAsStringWithoutMarkup()
```
  - getExcerpt
```
public String getExcerpt()
```
  - getAttachmentsUrlPath
```
public String getAttachmentsUrlPath()
```
  - getAttachmentNamed
```
public Attachment getAttachmentNamed(String fileName)
```
  - getVersionComment
```
public String getVersionComment()
```
  - setVersionComment
```
public void setVersionComment(String versionComment)
```
  - isVersionCommentAvailable
```
public boolean isVersionCommentAvailable()
```
  - getUserAccessor
```
@Deprecated
public UserAccessor getUserAccessor()
```
    Deprecated. since 4.0
  - setUserAccessor
```
@Deprecated
public void setUserAccessor(UserAccessor userAccessor)
```
    Deprecated. since 4.0
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class AbstractLabelableEntityObject
  - getRenderedVersionComment
```
public String getRenderedVersionComment()
```
  - getContentPermissionSet
```
public ContentPermissionSet getContentPermissionSet(String type)
```
    Note, this method does not return ContentPermissions inherited from the Content's ancestry.
    
    Returns:
    
    a set containing ContentPermissions of this type, or null if there are no content permissions explicitly set on this ContentEntityObject for the type.
  - hasPermissions
```
public boolean hasPermissions(String type)
```
    Returns:
    
    true if this content entity object contains any ContentPermissions of the type specified
  - hasContentPermissions
```
public boolean hasContentPermissions()
```
  - addPermission
```
public void addPermission(ContentPermission permission)
```
    Adds a ContentPermission. Do not add them manually via ContentPermissionSet.addContentPermission(ContentPermission). If possible use ContentPermissionManager.addContentPermission(com.atlassian.confluence.security.ContentPermission, ContentEntityObject) instead. Also note that as of Confluence 2.4 although methods have been added to facilitate having multiple ContentPermissions per page, Confluence does not yet properly support them (eg users permitted by them will not see the data in their searches)
  - removeContentPermissionSet
```
public void removeContentPermissionSet(ContentPermissionSet set)
```
    This method removes the given ContentPermissionSet from this CEO and disconnects the set from its owner. This method should only be called by the DefaultContentPermissionManager. Note that as of Confluence 2.4 although methods have been added to facilitate having multiple ContentPermissions per page, Confluence does not yet properly support them (eg users permitted by them will not see the data in their searches)
    
    See Also:
    
    DefaultContentPermissionManager.removeContentPermission(com.atlassian.confluence.security.ContentPermission)
  - getComments
```
public List<Comment> getComments()
```
  - setComments
```
public void setComments(List<Comment> comments)
```
  - addComment
```
public void addComment(Comment comment)
```
  - removeComment
```
public void removeComment(Comment comment)
```
  - addCustomContent
```
public void addCustomContent(CustomContentEntityObject customContentEntityObject)
```
  - removeCustomContent
```
public void removeCustomContent(CustomContentEntityObject customContentEntityObject)
```
  - getEntity
```
public ContentEntityObject getEntity()
```
    Description copied from interface: Content
    
    Gets the ContentEntityObject that backs this piece of content.
    
    Specified by:
    
    getEntity in interface Content
    
    Returns:
    
    the persistent object behind this content
  - ensureAttachmentBelongsToContent
```
protected void ensureAttachmentBelongsToContent(Attachment attachment)
```
  - getContentId
```
public ContentId getContentId()
```
    Returns the ContentId for this entity object, if it implements ContentConvertible.
    Subclasses implementing ContentConvertible must override this method.
    
    Returns:
    
    the ContentId representation of this object's id
    
    Throws:
    
    UnsupportedOperationException - if the instance doesn't implement ContentConvertible
  - getSelector
```
public ContentSelector getSelector()
```
    Returns:
    
    the ContentSelector for this entity, which will always include the id of the latest version, and the version number for this version of the entity.
  - getProperties
```
public ContentProperties getProperties()
```
    Returns:
    
    the content properties associated with this entity
  - getContainerContent
```
@Nullable
protected ContentEntityObject getContainerContent()
```
    Implementing classes wanting to be Contained in another CEO should implement the Contained interface and delegate to this method
    
    Returns:
    
    the CEO that contains this one
  - setContainerContent
```
protected void setContainerContent(@Nullable
                                   ContentEntityObject container)
```
  - replaceContentProperties
```
protected void replaceContentProperties(ContentProperties propertiesToClone)
```
    Clones the supplied properties and sets these as the properties of the current ContentEntityObject.
    This method should be used instead of directly modifying the contentProperties field, to avoid swapping collections that have Hibernate associations. Doing so would result in the following error: You may not dereference a collection with cascade="all-delete-orphan".
  - setContentPropertiesFrom
```
public void setContentPropertiesFrom(ContentEntityObject ceo)
```
    Initialises the ContentProperties of this ContentEntityObject by performing a deep clone of the ContentEntityObject object's properties.
  - getOriginalVersionId
```
public Long getOriginalVersionId()
```
  - setOriginalVersionId
```
protected void setOriginalVersionId(@Nullable
                                    Long originalVersionId)
```
    For Hibernate
  - getLatestVersionId
```
public long getLatestVersionId()
```

Class ContentEntityObject

Field Summary

Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

Fields inherited from interface com.atlassian.confluence.content.Content

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

Methods inherited from class com.atlassian.core.bean.EntityObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.bonnie.Searchable

Methods inherited from interface com.atlassian.confluence.core.Addressable

Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable

Field Detail

CURRENT

DELETED

CREATED

MODIFIED

DRAFT

SHARE_ID

SYNC_REV

DUMMY_SYNC_REV

SYNC_REV_SOURCE

COLLABORATIVE_EDITING_UUID

LIMITED_MODE_SYNC_REV_SOURCE

SYNCHRONY_SYNC_REV_SOURCE

SYNCHRONY_ACK_SYNC_REV_SOURCE

CONTENT_RESTORED_SYNC_REV_SOURCE

CONFLUENCE_RECOVERY

CONFLUENCE_RECOVERY_WITH_EXTERNAL_CHANGE

SYNCHRONY_RECOVERY

SYNCHRONY_RECOVERY_WITH_EXTERNAL_CHANGE

Constructor Detail

ContentEntityObject

Method Detail

getContentEntityObject

getType

getTypeEnum

getIdAsString

getDisplayTitle

getUrlPath

getAttachmentUrlPath

getTitle

setTitle

getLowerTitle

getDefaultBodyType

getBodyContent

getBodyContent

setBodyContent

getBodyAsString

setBodyAsString

getBodyContents

setBodyContents

getOutgoingLinks

setOutgoingLinks

addOutgoingLink

removeOutgoingLink

getReferralLinks

setReferralLinks

addReferralLink

removeReferralLink

getTrackbackLinks

setTrackbackLinks

addTrackbackLink

removeTrackbackLink

setOriginalVersion

convertToHistoricalVersion

applyChildVersioningPolicy

equals

hashCode

toString

getNameForComparison

compareTo

getSearchableDependants

toPageContext

isRecentlyUpdatedFor

isIndexable

getPermissions

getContentPermission