Package com.atlassian.confluence.internal

Interface ContentEntityManagerInternal

All Superinterfaces:

ContentDraftManagerInternal, ContentEntityManager

All Known Implementing Classes:

DefaultCommentManager, DefaultContentEntityManager, DefaultCustomContentManager, DefaultPageManager, DefaultPersonalInformationManager, DefaultSpaceDescriptionManager

@ParametersAreNonnullByDefault
public interface ContentEntityManagerInternal
extends ContentEntityManager, ContentDraftManagerInternal

Internal version of the ContentEntityManager interface; see the package-info.java for rationale.

Field Summary

Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager

ITERATE_ALL

Method Summary

Modifier and Type	Method	Description
@Nullable ContentEntityObject	getById(ContentId id)
@Nullable ContentEntityObject	getById(ContentId id, int version)
@NonNull PageResponse<ContentEntityObject>	getByIds(List<ContentId> contentIds, LimitedRequest limitedRequest, com.google.common.base.Predicate<? super ContentEntityObject>... filter)	Deprecated. since 7.0.1.
default @NonNull PageResponse<ContentEntityObject>	getByIdsAndFilters(List<ContentId> contentIds, LimitedRequest limitedRequest, Predicate<? super ContentEntityObject>... filter)
@NonNull PageResponse<VersionHistorySummary>	getVersionHistorySummaries(ContentId contentId, LimitedRequest limitedRequest)	Get a VersionHistorySummary for all previous versions of a ContentEntityObject, list is ordered by Version number descending.

Methods inherited from interface com.atlassian.confluence.internal.ContentDraftManagerInternal

createDraft, findAllDraftsFor, findAllDraftsWithUnpublishedChangesForUser, findDraftFor, findDraftFor, findUnpublishedContentWithUserContributions

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

getById, getContributionStatusByUser, getNextVersion, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionsLastEditedByUser, refreshContentEntity, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion

Method Detail

getById

@Nullable ContentEntityObject getById(ContentId id)

Returns:

the ContentEntityObject with the corresponding id or null if the object with that id does not exist

Throws:

UnsupportedOperationException - if the ContentId does not map to a ContentEntityObject

getById

@Nullable ContentEntityObject getById(ContentId id,
                                      int version)

Parameters:

id - the id of the last version CEO. Previous version ids will make this method return null

Returns:

the ContentEntityObject with the corresponding id and version or null if the object with that id and version does not exist. null will also be returned if the id points to a CEO which version is not the last one.

Throws:

UnsupportedOperationException - if the ContentId does not map to a ContentEntityObject

getByIds

@Deprecated
@NonNull PageResponse<ContentEntityObject> getByIds(List<ContentId> contentIds,
                                                    LimitedRequest limitedRequest,
                                                    com.google.common.base.Predicate<? super ContentEntityObject>... filter)

Deprecated.

since 7.0.1. Use getByIdsAndFilters(List, LimitedRequest, Predicate[])

Parameters:

contentIds - the contentIds of the candidate ContentEntityObjects

limitedRequest - the page request to apply

filter - an optional predicate

Returns:

fetch multiple contentEntityObjects by id that match the provided predicate

getByIdsAndFilters

default @NonNull PageResponse<ContentEntityObject> getByIdsAndFilters(List<ContentId> contentIds,
                                                                      LimitedRequest limitedRequest,
                                                                      Predicate<? super ContentEntityObject>... filter)

Parameters:

contentIds - the contentIds of the candidate ContentEntityObjects

limitedRequest - the page request to apply

filter - an optional predicate

Returns:

fetch multiple contentEntityObjects by id that match the provided predicate

Since:

7.0.1

getVersionHistorySummaries

@NonNull PageResponse<VersionHistorySummary> getVersionHistorySummaries(ContentId contentId,
                                                                        LimitedRequest limitedRequest)

Get a VersionHistorySummary for all previous versions of a ContentEntityObject, list is ordered by Version number descending. e.g. the list is started with the most recent content version as item 0.

Parameters:

contentId - the entity Id of the object to return the version history of

Returns:

the full version history of that object, as VersionHistorySummary objects.