Package de.espirit.firstspirit.storage

Interface HistoryProvider

All Known Subinterfaces:

Body, ChannelSourceProvider, Content2, Content2Section, ContentFolder, ContentProducer, ContentStoreRoot, DataProvider, Dataset, DocumentGroup, FormatTemplate, FormatTemplateContainer, FormatTemplateFolder, FormatTemplates, GCABody, GCAFolder, GCAPage, GCASection, GlobalContentArea, GlobalStoreRoot, GomSourceProvider, IDProvider, LinkTemplate, LinkTemplates, MasterTemplate, Media, MediaFolder, MediaStoreRoot, PackagePoolItem, Page, PageFolder, PageRef, PageRefFolder, PageStoreRoot, PageTemplate, PageTemplates, Previewable, PreviewImageProvider, ProjectProperties, Query, Referenceable, Schema, SchemaContainer, SchemaFolder, Schemes, Script, ScriptContainer, ScriptFolder, Scripts, Section<T>, SectionReference<T>, SectionTemplate, SectionTemplates, SiteStoreFolder, SiteStoreRoot, StartNode, Store, StyleTemplate, TableFormatTemplate, TableTemplate, Template, TemplateContainer<T>, TemplateContentProvider, TemplateFolder<T>, TemplateProvider<T>, TemplateStoreElement, TemplateStoreRoot, URLProperties, UserProperties, Workflow, WorkflowContainer, WorkflowFolder, Workflows

public interface HistoryProvider

Interface for providers of historical revision information.

Since:

4.0.42

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HistoryProvider.RevisionProvider	Wrapper on a HistoryProvider to act as ElementProvider on Revisions.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL_REVISIONS	Indicator for retrieving all revisions.
static final Date	EVER_SINCE	The date all others are after.
static final Date	UNTIL_NOW	The end of all time.

Method Summary

Modifier and Type	Method	Description
@NotNull ElementProvider<Revision>	asRevisionProvider()	Return an ElementProvider<Revision> on this HistoryProvider.
List<Revision>	getHistory()	Returns the revisions history of this storeelement, starting with the newest revision descending to the initial revision.
@NotNull List<Revision>	getHistory(@NotNull Date before, @NotNull Date after, int maxCount, @Nullable Filter<Revision> filter)	Returns a list of revisions of this store element in descending order. All returned revisions are in the specified time range.

Field Details

ALL_REVISIONS

static final int ALL_REVISIONS

Indicator for retrieving all revisions.

Since:

4.0.42

See Also:

• getHistory(Date, Date, int, Filter)
• Constant Field Values

EVER_SINCE

static final Date EVER_SINCE

The date all others are after.

Since:

4.0.42

See Also:

• getHistory(Date, Date, int, Filter)

UNTIL_NOW

static final Date UNTIL_NOW

The end of all time.

Since:

5.0.100

See Also:

• getHistory(Date, Date, int, Filter)

Method Details

getHistory

@ApiDoc(comment="Returns the revisions history of this storeelement, starting with the newest revision descending to the initial revision.",
        since="4.0.34")
List<Revision> getHistory()

Returns the revisions history of this storeelement, starting with the newest revision descending to the initial revision.

Returns:

A list of revisions in descending order.

Since:

4.0.34

getHistory

@ApiDoc(comment="Returns a list of revisions of this store element in descending order.",
        since="4.0.40")
@NotNull
@NotNull List<Revision> getHistory(@NotNull
 @NotNull Date before,
 @NotNull
 @NotNull Date after,
 int maxCount,
 @Nullable
 @Nullable Filter<Revision> filter)

Returns a list of revisions of this store element in descending order.
All returned revisions are in the specified time range. The list is sorted by time, newest first.

   after                                            before
  ---I-------------------------------------------------I---> time
                        I<---------------------------->I
                         result list containing "maxCount" entries
 

Parameters:

before - Marks upper date bound, so that revisions must be of this date or older to pass. Use UNTIL_NOW to retrieve revisions up to date. Do NOT use new Date()!

after - Marks lower date bound, so that revisions must be of this date or younger to pass. Use EVER_SINCE to retrieve revisions up to beginning of records.

maxCount - The maximum count of returned revisions. Use ALL_REVISIONS to get all revisions in specified time range.

filter - Filter to be passed. If null, accepts all elements. Useful filter implementations can be found in RevisionFilter. See Filter.Util for how to combine filters.

Returns:

A list of revisions that passed the given criteria in descending order.

Since:

4.0.40

asRevisionProvider

@ApiDoc(comment="Return an ElementProvider<Revision> on this HistoryProvider.",
        since="4.0.49")
@NotNull
@NotNull ElementProvider<Revision> asRevisionProvider()

Return an ElementProvider<Revision> on this HistoryProvider.

Returns:

An ElementProvider on Revisions.

Since:

4.0.49