Interface URLProperties
- All Superinterfaces:
Comparable<StoreElement>
,HistoryProvider
,IDProvider
,RootFolder
,StoreElement
,Workflowable
Provide stored URLs for
Determine the instance:
media
,
content producer
, or
folder
nodes.
Determine the instance:
StoreAgent
storeAgent = ...; URLProperties urlProperties = storeAgent.getStore(Type.GLOBALSTORE
).getChildren(URLProperties.class).getFirst();
- Since:
- 5.0.4
-
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 TypeMethodDescriptiongetAlternativeUrls
(@NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet) Get the list of alternative URLs for the specified parameter set.@Nullable String
getStoredUrl
(@NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet, @Nullable Object multiPageObject) Get the stored URL for the specified parameters set.@Nullable String
getStoredUrl
(@NotNull MediaFolder folder, @NotNull Language language) Get the stored URL for the specified parameter set.@Nullable String
getStoredUrl
(@NotNull Media node, @Nullable Language language, @Nullable Resolution resolution) Get the stored URL for the specified parameter set.@Nullable String
getStoredUrl
(@NotNull SiteStoreFolder folder, @NotNull Language language, @NotNull TemplateSet templateSet) Get the stored URL for the specified parameter set.int
resetStoredUrls
(@NotNull IDProvider node) Reset the stored URLs for the specified node.void
setAlternativeUrls
(@NotNull Collection<String> urls, @NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet) Set the list of alternative URLs for the specified parameter set.void
setStoredUrl
(@Nullable String url, @NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet, @Nullable Object multiPageObject) Set the stored URL for the specified parameters set.void
setStoredUrl
(@Nullable String url, @NotNull MediaFolder folder, @NotNull Language language) Set the stored URL for the specified parameter set.void
setStoredUrl
(@Nullable String url, @NotNull Media node, @Nullable Language language, @Nullable Resolution resolution) Set the stored URL for the specified parameter set.void
setStoredUrl
(@Nullable String url, @NotNull SiteStoreFolder folder, @NotNull Language language, @NotNull TemplateSet templateSet) Set the stored URL for the specified parameter set.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, getReleaseRevision, getReleaseStatus, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isInReleaseStore, isReleased, isReleased, isReleaseSupported, moveChild, moveChild, release, release, 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, 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
-
getStoredUrl
@Nullable @Nullable String getStoredUrl(@NotNull @NotNull ContentProducer node, @NotNull @NotNull Language language, @NotNull @NotNull TemplateSet templateSet, @Nullable @Nullable Object multiPageObject) Get the stored URL for the specified parameters set. An URL may be stored manually or automatically when the node is first generated (for the provided parameter set).- Parameters:
node
- Node to get the URL for.language
- Language to get the URL for.templateSet
- TemplateSet to get the URL for.multiPageObject
- Parameter object for multi pages, ornull
. Provide e.g. aEntity
for content store based multi pages.- Returns:
- The stored URL (absolute, without domain prefix) or
null
if no URL is stored (yet). - Throws:
NullPointerException
- if either parameternode
,language
ortemplateSet
isnull
.- Since:
- 5.0.4
- See Also:
-
setStoredUrl
void setStoredUrl(@Nullable @Nullable String url, @NotNull @NotNull ContentProducer node, @NotNull @NotNull Language language, @NotNull @NotNull TemplateSet templateSet, @Nullable @Nullable Object multiPageObject) Set the stored URL for the specified parameters set.- Parameters:
url
- url to set (may benull
).node
- Node to set the URL for.language
- Language to set the URL for.templateSet
- TemplateSet to set the URL for.multiPageObject
- Parameter object for multi pages, ornull
. Provide e.g. aEntity
for content store based multi pages.- Throws:
NullPointerException
- if either parameternode
,language
ortemplateSet
isnull
.- Since:
- 5.0.5
- See Also:
-
getAlternativeUrls
@NotNull @NotNull List<String> getAlternativeUrls(@NotNull @NotNull ContentProducer node, @NotNull @NotNull Language language, @NotNull @NotNull TemplateSet templateSet) Get the list of alternative URLs for the specified parameter set. The returned list is read-only and sorted.- Parameters:
node
- Node to get the URLs for.language
- Language to get the URLs for.templateSet
- TemplateSet to get the URLs for.- Returns:
- A list of alternative URLs.
- Since:
- 5.0.5
- See Also:
-
setAlternativeUrls
void setAlternativeUrls(@NotNull @NotNull Collection<String> urls, @NotNull @NotNull ContentProducer node, @NotNull @NotNull Language language, @NotNull @NotNull TemplateSet templateSet) Set the list of alternative URLs for the specified parameter set.- Parameters:
urls
- List of alternative urls.node
- Node to set the URLs for.language
- Language to set the URLs for.templateSet
- TemplateSet to set the URLs for.- Since:
- 5.0.5
- See Also:
-
getStoredUrl
@Nullable @Nullable String getStoredUrl(@NotNull @NotNull SiteStoreFolder folder, @NotNull @NotNull Language language, @NotNull @NotNull TemplateSet templateSet) Get the stored URL for the specified parameter set.- Parameters:
folder
- Node to get the URL for.language
- Language to get the URL for.templateSet
- TemplateSet to get the URL for.- Returns:
- The stored URL (absolute, without domain prefix) or
null
if no URL is stored (yet). - Throws:
NullPointerException
- if either parameterfolder
,language
, ortemplateSet
isnull
.- Since:
- 5.0.4
- See Also:
-
setStoredUrl
void setStoredUrl(@Nullable @Nullable String url, @NotNull @NotNull SiteStoreFolder folder, @NotNull @NotNull Language language, @NotNull @NotNull TemplateSet templateSet) Set the stored URL for the specified parameter set.- Parameters:
url
- url to set (may benull
).folder
- Folder to set the URL for.language
- Language to set the URL for.templateSet
- TemplateSet to set the URL for.- Throws:
NullPointerException
- if either parameterfolder
,language
, ortemplateSet
isnull
.- Since:
- 5.0.5
- See Also:
-
getStoredUrl
@Nullable @Nullable String getStoredUrl(@NotNull @NotNull MediaFolder folder, @NotNull @NotNull Language language) Get the stored URL for the specified parameter set.- Parameters:
folder
- Folder to get the URL for.language
- Language to get the URL for.- Returns:
- The stored URL (absolute, without domain prefix) or
null
if no URL is stored (yet). - Throws:
NullPointerException
- if either parameternode
orlanguage
isnull
.- Since:
- 5.0.9
- See Also:
-
setStoredUrl
void setStoredUrl(@Nullable @Nullable String url, @NotNull @NotNull MediaFolder folder, @NotNull @NotNull Language language) Set the stored URL for the specified parameter set.- Parameters:
url
- url to set (may benull
).folder
- Folder to set the URL for.language
- Language to set the URL for.- Throws:
NullPointerException
- if either parameterfolder
orlanguage
isnull
.- Since:
- 5.0.9
- See Also:
-
getStoredUrl
@Nullable @Nullable String getStoredUrl(@NotNull @NotNull Media node, @Nullable @Nullable Language language, @Nullable @Nullable Resolution resolution) Get the stored URL for the specified parameter set.- Parameters:
node
- Node to get the URL for.language
- Language to get the URL for. May benull
for language independent media nodes.resolution
- Resolution to get the URL for. Could benull
for media nodes oftype
Media.FILE
.- Returns:
- The stored URL (absolute, without domain prefix) or
null
if no URL is stored (yet). - Throws:
NullPointerException
- ifnode
isnull
or if parameterlanguage
isnull
and provided node islanguage dependent
or parameterresolution
isnull
and this node is oftype
Media.PICTURE
.- Since:
- 5.0.4
- See Also:
-
setStoredUrl
void setStoredUrl(@Nullable @Nullable String url, @NotNull @NotNull Media node, @Nullable @Nullable Language language, @Nullable @Nullable Resolution resolution) Set the stored URL for the specified parameter set.- Parameters:
url
- url to set (may benull
).node
- Node to set the URL for.language
- Language to get the URL for. May benull
for language independent media nodes.resolution
- Resolution to set the URL for. May benull
for media nodes oftype
Media.FILE
.- Throws:
NullPointerException
- ifnode
isnull
or if parameterlanguage
isnull
and provided node islanguage dependent
or parameterresolution
isnull
and this node is oftype
Media.PICTURE
.- Since:
- 5.0.5
- See Also:
-
resetStoredUrls
Reset the stored URLs for the specified node. If the node is a folder the URLs of all child nodes are reset.The
URLProperties
node must belocked
when this method is called (the lock state of the node which is passed does not matter).- Parameters:
node
- node of typePageRef
,DocumentGroup
,PageFolder
, orMedia
.- Returns:
- number of resetted urls
- Since:
- 5.0.4
-