Package de.espirit.firstspirit.access.store

Interface ContentProducer

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, Workflowable

All Known Subinterfaces:

DocumentGroup, GCAPage, Page, PageRef

public interface ContentProducer
extends IDProvider

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Field Summary

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Method Summary

Modifier and Type	Method	Description
void	createContent(@NotNull GenerationContext gc, @NotNull PageParams params)
String	getExtension(@NotNull TemplateSet templateSet)	Get the file / url extension for this content producer, e.g.
@NotNull String	getFilename()	Get a file or link name for this content producer; without path information and extension, e.g.
MultiPageParams	getMultiPageParams(@NotNull Language language, @NotNull TemplateSet templateSet)
@Nullable String	getStoredUrl(@NotNull Language language, @NotNull TemplateSet templateSet, @Nullable Object multiPageObject)	Get the stored URL for this node and the provided combination of language, template set, and (optionally) entity.
String	getUrl(@NotNull UrlCreatorProvider urlCreatorProvider, @NotNull Language lang, @NotNull TemplateSet templateSet, @NotNull PageParams pageParams, int mode)	Create an url for this node using the specified urlCreatorProvider, language, template set, and pageParams(sub page).

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

createContent

void createContent(@NotNull
 @NotNull GenerationContext gc,
 @NotNull
 @NotNull PageParams params)
            throws IOException

Throws:

IOException

Since:

4.0

getFilename

@NotNull
@NotNull String getFilename()

Get a file or link name for this content producer; without path information and extension, e.g. "index"

Returns:

a filename without path information and extension

Since:

4.0.54

getExtension

String getExtension(@NotNull
 @NotNull TemplateSet templateSet)

Get the file / url extension for this content producer, e.g. "html" or "jsp".

Since:

4.0

getMultiPageParams

MultiPageParams getMultiPageParams(@NotNull
 @NotNull Language language,
 @NotNull
 @NotNull TemplateSet templateSet)

Since:

4.0

getUrl

String getUrl(@NotNull
 @NotNull UrlCreatorProvider urlCreatorProvider,
 @NotNull
 @NotNull Language lang,
 @NotNull
 @NotNull TemplateSet templateSet,
 @NotNull
 @NotNull PageParams pageParams,
 int mode)

Create an url for this node using the specified urlCreatorProvider, language, template set, and pageParams(sub page).

Parameters:

urlCreatorProvider - the url creator provider to use

lang - language

templateSet - template set

pageParams - sub page

mode - see UrlCreator.Mode

Since:

4.1.27

getStoredUrl

@Nullable
@Nullable String getStoredUrl(@NotNull
 @NotNull Language language,
 @NotNull
 @NotNull TemplateSet templateSet,
 @Nullable
 @Nullable Object multiPageObject)

Get the stored URL for this node and the provided combination of language, template set, and (optionally) entity. Returns null if no URL is (yet) stored.

Parameters:

language - Language to get the URL for.

templateSet - TemplateSet to get the URL for.

multiPageObject - Parameter object for multi pages, or null. Provide e.g. an entity for content store based multi pages.

Returns:

The stored URL or null, if no URL is yet stored.

Throws:

NullPointerException - if either parameter language or templateSet is null.

Since:

5.0.4

See Also:

• URLProperties.getStoredUrl(ContentProducer, Language, TemplateSet, Object)