public interface

ContentEntityManager

com.atlassian.confluence.core.ContentEntityManager
Known Indirect Subclasses

Summary

Constants
int ITERATE_ALL
Public Methods
abstract Iterator getAllCurrentEntities()
This method is deprecated. since 3.1 do not use. Retrieving all content in the system may cause performance issues.
abstract ContentEntityObject getById(long id)
abstract List getLockedBySpace(String spaceKey)
This method is deprecated. since 2.10. There is no replacement as this functionality was superseded by multiple page permissions (CONF-3701)
abstract ContentEntityObject getNextVersion(ContentEntityObject ceo)
abstract ContentEntityObject getOtherVersion(ContentEntityObject ceo, int version)
abstract ContentEntityObject getPreviousVersion(ContentEntityObject ceo)
abstract Iterator getRecentlyAddedEntities(String spaceKey, int maxResults)
Retrieve an iterator of recently added entities, in order of most recent to last.
abstract Iterator getRecentlyModifiedEntities(String spaceKey, int maxResults)
Retrieve an iterator of recently modified entities, in order of most recent to last.
abstract Iterator getRecentlyModifiedEntitiesForUser(String username)
Retrieve an iterator of recently modified entities, in order of most recent to last.
abstract List getRecentlyModifiedForChangeDigest(Date fromDate)
Retrieves a list of ContentEntityObjects that have been newly added or modified since the date specified.
abstract List<VersionHistorySummary> getVersionHistorySummaries(ContentEntityObject ceo)
Get a VersionHistorySummary for all previous versions of a ContentEntityObject, starting with the current content.
abstract void refreshContentEntity(ContentEntityObject obj)
This method is deprecated. since 3.1 method is not used
abstract void removeContentEntity(ContentEntityObject obj)
Removes given content entity object and all associated domain objects i.e.
abstract void revertContentEntityBackToVersion(ContentEntityObject obj, int version, String revertComment, boolean revertTitle)
Reverts a ContentEntityObject back to its state at the version specified by version.
abstract void revertContentEntityBackToVersion(ContentEntityObject obj, int version)
This method is deprecated. since 2.9, use revertContentEntityBackToVersion(ContentEntityObject, int, String, boolean) instead
abstract void saveContentEntity(ContentEntityObject obj, ContentEntityObject origObj, SaveContext saveContext)
In order to create a history for this object, we need to pass in the modified as well as the original version of the object.
abstract void saveContentEntity(ContentEntityObject obj, SaveContext saveContext)
abstract void setEventManager(EventManager eventManager)
This method is deprecated. since 3.1 do not use. Implementation detail mistakenly added to service interface.
abstract void updateContentLinkingTo(SpaceContentEntityObject contentBeingRefactored, String newSpaceKey, String newTitle)
Loops through all the content that currently links to 'contentBeingChanged' and renames all the links.
abstract void updateOutgoingLinksInContent(SpaceContentEntityObject contentBeingRefactored, String newSpaceKey)
Update the links on the page itself.
abstract void updateSingleContentLinkinTo(ContentEntityObject referringContent, SpaceContentEntityObject contentBeingRefactored, String newSpaceKey, String newTitle)
Renames all links contained in the 'referringContent' that currently links to 'contentBeingRefactored'.
abstract void updateSingleContentLinkinTo(ContentEntityObject referringContent, SpaceContentEntityObject contentBeingRefactored, String newSpaceKey, String newTitle, SaveContext saveContext)

Constants

public static final int ITERATE_ALL

Constant Value: 0 (0x00000000)

Public Methods

public abstract Iterator getAllCurrentEntities ()

This method is deprecated.
since 3.1 do not use. Retrieving all content in the system may cause performance issues.

public abstract ContentEntityObject getById (long id)

public abstract List getLockedBySpace (String spaceKey)

This method is deprecated.
since 2.10. There is no replacement as this functionality was superseded by multiple page permissions (CONF-3701)

public abstract ContentEntityObject getNextVersion (ContentEntityObject ceo)

public abstract ContentEntityObject getOtherVersion (ContentEntityObject ceo, int version)

public abstract ContentEntityObject getPreviousVersion (ContentEntityObject ceo)

public abstract Iterator getRecentlyAddedEntities (String spaceKey, int maxResults)

Retrieve an iterator of recently added entities, in order of most recent to last. The iterator is lazy-loading, so you can filter the output and return the first 'n' that interest you. For performance reasons, it's a VERY bad idea to supply both a space key, and infinite results. If you supply a space key, this WILL NOT RETURN ANY COMMENTS. There is currently no way around this, you have to retrieve comments separately and splice the results together. Sorry.

Parameters
spaceKey the space key to look up the entities for. If spaceKey is null, there is assumed to be no space, and things like user info and space descriptions will also be returned.
maxResults the maximum number of entities to return in the iterator. Any number zero or less (Use the ITERATE_ALL constant) will cause the iterator to go over every entity.

public abstract Iterator getRecentlyModifiedEntities (String spaceKey, int maxResults)

Retrieve an iterator of recently modified entities, in order of most recent to last. The iterator is lazy-loading, so you can filter the output and return the first 'n' that interest you. For performance reasons, it's a VERY bad idea to supply both a space key, and infinite results.

Parameters
spaceKey the space key to look up the entities for.
maxResults the maximum number of entities to return in the iterator. Any number zero or less (Use the ITERATE_ALL constant) will cause the iterator to go over every entity.

public abstract Iterator getRecentlyModifiedEntitiesForUser (String username)

Retrieve an iterator of recently modified entities, in order of most recent to last. The iterator is lazy-loading, so you can filter the output and return the first 'n' that interest you.

Parameters
username the user for which to retrieve the modified content

public abstract List getRecentlyModifiedForChangeDigest (Date fromDate)

Retrieves a list of ContentEntityObjects that have been newly added or modified since the date specified. This list excludes drafts, space descriptions and mail.

Parameters
fromDate content modified after this date will be returned
Returns
  • a list of ContentEntityObjects that have been newly added or modified since the date specified

public abstract List<VersionHistorySummary> getVersionHistorySummaries (ContentEntityObject ceo)

Get a VersionHistorySummary for all previous versions of a ContentEntityObject, starting with the current content.

Parameters
ceo the entity object to return the version history of
Returns
  • the full version history of that object, as VersionHistorySummary objects.

public abstract void refreshContentEntity (ContentEntityObject obj)

This method is deprecated.
since 3.1 method is not used

public abstract void removeContentEntity (ContentEntityObject obj)

Removes given content entity object and all associated domain objects i.e. if we remove a page it removes all its labels and attachments

public abstract void revertContentEntityBackToVersion (ContentEntityObject obj, int version, String revertComment, boolean revertTitle)

Reverts a ContentEntityObject back to its state at the version specified by version. Creates a new latest version that resembles the previous state.

Parameters
obj The ContentEntityObject to revert
version The version to revert to
revertComment A comment to be associated with the revert
revertTitle If true, the ContentEntityObject title will be reverted to the old state

public abstract void revertContentEntityBackToVersion (ContentEntityObject obj, int version)

This method is deprecated.
since 2.9, use revertContentEntityBackToVersion(ContentEntityObject, int, String, boolean) instead

public abstract void saveContentEntity (ContentEntityObject obj, ContentEntityObject origObj, SaveContext saveContext)

In order to create a history for this object, we need to pass in the modified as well as the original version of the object.

Parameters
saveContext - a SaveContext holding additional parameters for the manager to use when saving.

public abstract void saveContentEntity (ContentEntityObject obj, SaveContext saveContext)

Parameters
obj - the ContentEntityObject to save
saveContext - a SaveContext object for the manager.

public abstract void setEventManager (EventManager eventManager)

This method is deprecated.
since 3.1 do not use. Implementation detail mistakenly added to service interface.

public abstract void updateContentLinkingTo (SpaceContentEntityObject contentBeingRefactored, String newSpaceKey, String newTitle)

Loops through all the content that currently links to 'contentBeingChanged' and renames all the links.
This will skip any referring content that is the 'contentBeingChanged' (i.e. content links to itself).
If you only want to change the links of a specific content object, use the 'updateSingleContentLinkinTo' function.
This rename will be recorded in the content's history

public abstract void updateOutgoingLinksInContent (SpaceContentEntityObject contentBeingRefactored, String newSpaceKey)

Update the links on the page itself. If links are local (refering to the current space), a spacekey has to be added to the link

public abstract void updateSingleContentLinkinTo (ContentEntityObject referringContent, SpaceContentEntityObject contentBeingRefactored, String newSpaceKey, String newTitle)

Renames all links contained in the 'referringContent' that currently links to 'contentBeingRefactored'.
This rename will be recorded in the content's history

public abstract void updateSingleContentLinkinTo (ContentEntityObject referringContent, SpaceContentEntityObject contentBeingRefactored, String newSpaceKey, String newTitle, SaveContext saveContext)