public interface ContentProducer extends IDProvider
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
void |
createContent(GenerationContext gc,
PageParams params) |
String |
getExtension(TemplateSet templateSet)
Get the file / url extension for this content producer, e.g.
|
String |
getFilename()
Get a file or link name for this content producer; without path information and extension, e.g.
|
MultiPageParams |
getMultiPageParams(Language language,
TemplateSet templateSet) |
String |
getStoredUrl(Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for this node and the provided combination of language, template set, and (optionally) entity.
|
String |
getUrl(UrlCreatorProvider urlCreatorProvider,
Language lang,
TemplateSet templateSet,
PageParams pageParams,
int mode)
Create an url for this node using the specified
urlCreatorProvider ,
language , template set , and pageParams (sub page). |
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, setMeta, setMetaFormData, setUid
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, 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, update
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
void createContent(@NotNull GenerationContext gc, @NotNull PageParams params) throws IOException
IOException
@NotNull String getFilename()
String getExtension(@NotNull TemplateSet templateSet)
MultiPageParams getMultiPageParams(@NotNull Language language, @NotNull TemplateSet templateSet)
String getUrl(@NotNull UrlCreatorProvider urlCreatorProvider, @NotNull Language lang, @NotNull TemplateSet templateSet, @NotNull PageParams pageParams, int mode)
urlCreatorProvider
,
language
, template set
, and pageParams
(sub page).urlCreatorProvider
- the url creator provider to uselang
- languagetemplateSet
- template setpageParams
- sub pagemode
- see UrlCreator.Mode
@Nullable String getStoredUrl(@NotNull Language language, @NotNull TemplateSet templateSet, @Nullable Object multiPageObject)
null
if no URL is (yet) stored.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.null
, if no URL is yet stored.NullPointerException
- if either parameter language
or templateSet
is null
.URLProperties.getStoredUrl(ContentProducer, Language, TemplateSet, Object)
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500