com.atlassian.confluence.core.persistence

Interface ContentEntityObjectDao

All Superinterfaces:

ObjectDao, VersionedObjectDao

All Known Subinterfaces:

ContentDao, CustomContentDao, PageDao, UserStatusDao

All Known Implementing Classes:

CachingPageDao, ContentEntityObjectHibernateDao, DefaultContentDao, HibernatePageDao, HibernateUserStatusDao, PluginContentHibernateDao

public interface ContentEntityObjectDao
extends VersionedObjectDao

Field Summary

Fields inherited from interface bucket.core.persistence.ObjectDao

NON_CACHEABLE

Method Summary

Modifier and Type	Method and Description
int	countContentBySpaceIdAndStatus(long spaceId, String status) Retrieve the count of content for a given space with a particular status.
List<ContentEntityObject>	findAllDraftsFor(long contentId) Retrieves a list of drafts for the given content if any drafts exist.
List<ContentEntityObject>	findContentBySpaceIdAndStatus(long spaceId, String status, int offset, int count) Retrieve content for a given space with a particular status.
ContentEntityObject	findDraftFor(long contentId) Retrieves the draft for the given content if exists.
List	findHistoricalVersionsAfterVersion(long originalContentId, int version)
List	findPreviousVersions(long originalContentId)
List<ContentEntityObject>	findUnpublishedContentWithUserContributions(String username) Deprecated. Used for the old "Drafts" page, which is superseded by "Recently worked on". Remove if "Drafts" page is removed
Iterator	getAllCurrentEntities()
ContentEntityObject	getById(long id)
List	getContentAuthoredByUser(String username)
Map<Long,ContributionStatus>	getContributionStatusByUser(Collection<ContentId> contentIds, com.atlassian.sal.api.user.UserKey userKey) Identifies the most recent contributions made to a set of content by the given user.
ContentEntityObject	getFirstVersionAfter(long originalVersionContentId, int version)
ContentEntityObject	getFirstVersionBefore(long originalVersionContentId, int version)
List<ContentEntityObject>	getLastEditedVersionsOf(ContentEntityObject content) Retrieves all the last edited versions for each user who has contributed to the specified piece of content.
String	getObjectType(long id)
Date	getOldestPageCreationDate() Gets the creation date of the oldest page.
PageResponse<AbstractPage>	getPageAndBlogPostsVersionsLastEditedByUser(com.atlassian.sal.api.user.UserKey userKey, LimitedRequest request) Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification.
PageResponse<AbstractPage>	getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts(com.atlassian.sal.api.user.UserKey userKey, LimitedRequest request) Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification.
Iterator	getRecentlyAddedEntities(String spaceKey, int maxResults)
Iterator	getRecentlyModifiedEntities(int maxResults)
Iterator	getRecentlyModifiedEntities(String spaceKey, int maxResults)
Iterator	getRecentlyModifiedEntitiesForUser(String username)
List	getRecentlyModifiedForChangeDigest(Date fromDate) Retrieves a list of ContentEntityObjects that have been newly added or modified since the date specified.
List	getTrashedContent(String spaceKey) Get trashed content for a space.
List<ContentEntityObject>	getTrashedContent(String spaceKey, int offset, int count) Get trashed content for a space, with pagination.
ContentEntityObject	getVersion(long originalVersionContentId, int version)
Map<Long,List<ConfluenceUser>>	getVersionEditContributors(Iterable<ContentEntityObject> originalVersions) Get version edit contributors for a set of content identifiers.
List<VersionHistorySummary>	getVersionHistorySummary(long originalContentId)
PageResponse<VersionHistorySummary>	getVersionHistorySummary(long originalContentId, LimitedRequest request) Get version history with pagination.
Map<Long,ContentEntityObject>	getVersionsLastEditedByUser(Collection<Long> contentIds, com.atlassian.sal.api.user.UserKey userKey) Gets the ContentEntityObject objects, either the current version or historical version relating to given contentIds of the current version that was the most recent version edited by the given user.

Methods inherited from interface com.atlassian.confluence.core.persistence.VersionedObjectDao

findLatestVersionsCount, findLatestVersionsIterator, save

Methods inherited from interface bucket.core.persistence.ObjectDao

findAll, findAllSorted, findAllSorted, findByClassIds, findByClassIds, getPersistentClass, refresh, remove, replicate, save, saveRaw

Method Detail

getById

ContentEntityObject getById(long id)

getContentAuthoredByUser

List getContentAuthoredByUser(String username)

getAllCurrentEntities

Iterator getAllCurrentEntities()

getRecentlyAddedEntities

Iterator getRecentlyAddedEntities(String spaceKey,
                                  int maxResults)

getRecentlyModifiedEntities

Iterator getRecentlyModifiedEntities(int maxResults)

getRecentlyModifiedEntities

Iterator getRecentlyModifiedEntities(String spaceKey,
                                     int maxResults)

getRecentlyModifiedForChangeDigest

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

getRecentlyModifiedEntitiesForUser

Iterator getRecentlyModifiedEntitiesForUser(String username)

getTrashedContent

List getTrashedContent(String spaceKey)

Get trashed content for a space. Caution: returns all content without pagination. Only "top-level" trashed items will be retrieved, i.e. not their contained children.

Parameters:

spaceKey - the space key for which all trash will be retrieved

Returns:

the list of trashed content

getTrashedContent

List<ContentEntityObject> getTrashedContent(String spaceKey,
                                            int offset,
                                            int count)

Get trashed content for a space, with pagination. Only "top-level" trashed items will be retrieved, i.e. not their contained children.

Parameters:

spaceKey - the space key for which trash will be retrieved

offset - the offset of the first item to retrieve (0-based)

count - the maximum number of items to retrieve

Returns:

the list of trashed content

getObjectType

String getObjectType(long id)

getFirstVersionBefore

ContentEntityObject getFirstVersionBefore(long originalVersionContentId,
                                          int version)

getFirstVersionAfter

ContentEntityObject getFirstVersionAfter(long originalVersionContentId,
                                         int version)

getVersion

ContentEntityObject getVersion(long originalVersionContentId,
                               int version)

getVersionHistorySummary

List<VersionHistorySummary> getVersionHistorySummary(long originalContentId)

getVersionHistorySummary

PageResponse<VersionHistorySummary> getVersionHistorySummary(long originalContentId,
                                                             LimitedRequest request)

Get version history with pagination. So we don't have issue with super long history.

Parameters:

originalContentId - the content Id of latest version, the CURRENT version

request - page request contains start, limit fields for pagination purpose.

Returns:

PageResponse of version history.

getVersionEditContributors

Map<Long,List<ConfluenceUser>> getVersionEditContributors(Iterable<ContentEntityObject> originalVersions)

Get version edit contributors for a set of content identifiers. This returns the last modified of all versions of the content.

Parameters:

originalVersions - the contents of latest versions, the CURRENT versions

Returns:

A map between content identifiers and a list of contributors (ordered by name, with null (for anonymous) first).

getVersionsLastEditedByUser

Map<Long,ContentEntityObject> getVersionsLastEditedByUser(Collection<Long> contentIds,
                                                          com.atlassian.sal.api.user.UserKey userKey)

Gets the ContentEntityObject objects, either the current version or historical version relating to given contentIds of the current version that was the most recent version edited by the given user. Only content with a "current" status are returned.

Parameters:

contentIds - the ids of the content we're interested in. These *must* be ids of the latest version.

userKey - the userKey of the user that we're interested in

Returns:

the ContentEntityObject objects relating to the version of the given contentIds that were last edited by the given user.

Since:

5.9.0

getContributionStatusByUser

Map<Long,ContributionStatus> getContributionStatusByUser(Collection<ContentId> contentIds,
                                                         com.atlassian.sal.api.user.UserKey userKey)

Identifies the most recent contributions made to a set of content by the given user. A contribution can either be a page publish, or a set of unpublished changes which have been saved to a draft. Does not return a ContributionStatus for a content ID if the user has never contributed to the content.

Parameters:

contentIds - the IDs of the content we want to query. These *must* be IDs of the latest version

userKey - the userKey of the user who's changes we are interested in

Returns:

the ContributionStatus of each content

getPageAndBlogPostsVersionsLastEditedByUser

PageResponse<AbstractPage> getPageAndBlogPostsVersionsLastEditedByUser(@Nullable
                                                                       com.atlassian.sal.api.user.UserKey userKey,
                                                                       LimitedRequest request)

Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification. Only content with a "current" status are returned.

Parameters:

userKey - the key for the user for whom to retrieve the modified content

request - the request

Since:

5.9.1

getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts

PageResponse<AbstractPage> getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts(@Nullable
                                                                                      com.atlassian.sal.api.user.UserKey userKey,
                                                                                      LimitedRequest request)

Retrieve a page of entities, either the current version or historical version, that have been modified by the user, in order of the user's most recent modification. Only content with "current" or "draft" status are returned.

Parameters:

userKey - the key for the user for whom to retrieve the modified content

request - the request

findPreviousVersions

List findPreviousVersions(long originalContentId)

findHistoricalVersionsAfterVersion

List findHistoricalVersionsAfterVersion(long originalContentId,
                                        int version)

getLastEditedVersionsOf

List<ContentEntityObject> getLastEditedVersionsOf(ContentEntityObject content)

Retrieves all the last edited versions for each user who has contributed to the specified piece of content. That is, if a user has contributed multiple edits, only the version that corresponds to their latest edit will be added to the list returned. Result will be sorted with the earliest version coming first.

Parameters:

content - content (must be the latest version)

Returns:

the last edited versions for each user who has contributed to the specified piece of content.

Throws:

IllegalArgumentException - if the content is not the latest version or null

findContentBySpaceIdAndStatus

List<ContentEntityObject> findContentBySpaceIdAndStatus(long spaceId,
                                                        String status,
                                                        int offset,
                                                        int count)

Retrieve content for a given space with a particular status. Results will be sorted by descending date of last modification.

Parameters:

spaceId - the id of the space

status - the status of the content being retrieved (e.g. ContentEntityObject.DELETED

offset - the offset of the first item to retrieve (0-based)

count - the maximum number of items to retrieve

Returns:

the list of content matching the query

countContentBySpaceIdAndStatus

int countContentBySpaceIdAndStatus(long spaceId,
                                   String status)

Retrieve the count of content for a given space with a particular status.

Parameters:

spaceId - the id of the space

status - the status of the content being retrieved (e.g. ContentEntityObject.DELETED

Returns:

the number of content objects with that status in that space

getOldestPageCreationDate

Date getOldestPageCreationDate()

Gets the creation date of the oldest page.

Returns:

creation date of the oldest page in Confluence

findDraftFor

ContentEntityObject findDraftFor(long contentId)

Retrieves the draft for the given content if exists.

Parameters:

contentId - id of the content to retrieve the draft for

Returns:

the draft for the given content if exists, null otherwise

See Also:

ContentEntityObject.DRAFT

findAllDraftsFor

List<ContentEntityObject> findAllDraftsFor(long contentId)

Retrieves a list of drafts for the given content if any drafts exist.

Parameters:

contentId - id of the content to retrieve the draft for

Returns:

a non-null list of drafts, with 0 or more elements.

See Also:

ContentEntityObject.DRAFT

findUnpublishedContentWithUserContributions

@Deprecated
List<ContentEntityObject> findUnpublishedContentWithUserContributions(String username)

Deprecated. Used for the old "Drafts" page, which is superseded by "Recently worked on". Remove if "Drafts" page is removed

Retrives the drafts for the given User

Parameters:

username - the owner of the drafts

Returns:

a list of ContentEntityObject with the ContentEntityObject.DRAFT status