public interface URLProperties extends StoreElement, RootFolder
media
,
content producer
, or
folder
nodes.
Determine the instance: StoreAgent
storeAgent = ...; URLProperties urlProperties = storeAgent.getStore(Type.GLOBALSTORE
).getChildren(URLProperties.class).getFirst();
Modifier and Type | Method and Description |
---|---|
List<String> |
getAlternativeUrls(ContentProducer node,
Language language,
TemplateSet templateSet)
Get the list of altenrnative URLs for the specified parameter set.
|
String |
getStoredUrl(ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for the specified parameters set.
|
String |
getStoredUrl(MediaFolder folder,
Language language)
Get the stored URL for the specified parameter set.
|
String |
getStoredUrl(Media node,
Language language,
Resolution resolution)
Get the stored URL for the specified parameter set.
|
String |
getStoredUrl(SiteStoreFolder folder,
Language language,
TemplateSet templateSet)
Get the stored URL for the specified parameter set.
|
int |
resetStoredUrls(IDProvider node)
Reset the stored URLs for the specified node.
|
void |
setAlternativeUrls(Collection<String> urls,
ContentProducer node,
Language language,
TemplateSet templateSet)
Set the list of altenrnative URLs for the specified parameter set.
|
void |
setStoredUrl(String url,
ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Set the stored URL for the specified parameters set.
|
void |
setStoredUrl(String url,
MediaFolder folder,
Language language)
Set the stored URL for the specified parameter set.
|
void |
setStoredUrl(String url,
Media node,
Language language,
Resolution resolution)
Get the stored URL for the specified parameter set.
|
void |
setStoredUrl(String url,
SiteStoreFolder folder,
Language language,
TemplateSet templateSet)
Set the stored URL for the specified parameter set.
|
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getParent, 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
@Nullable String getStoredUrl(@NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet, @Nullable Object multiPageObject)
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, or null
. Provide e.g. a Entity
for
content store based multi pages.null
if no URL is stored (yet).NullPointerException
- if either parameter node
, language
or templateSet
is
null
.setStoredUrl(String, ContentProducer, Language, TemplateSet, Object)
,
ContentProducer.getStoredUrl(Language, TemplateSet, Object)
void setStoredUrl(@Nullable String url, @NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet, @Nullable Object multiPageObject)
url
- url to set (may be null
).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, or null
. Provide e.g. a Entity
for
content store based multi pages.NullPointerException
- if either parameter node
, language
or templateSet
is
null
.getStoredUrl(ContentProducer, Language, TemplateSet, Object)
@NotNull List<String> getAlternativeUrls(@NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet)
node
- Node to get the URLs for.language
- Language to get the URLs for.templateSet
- TemplateSet to get the URLs for.setAlternativeUrls(Collection, ContentProducer, Language, TemplateSet)
void setAlternativeUrls(@NotNull Collection<String> urls, @NotNull ContentProducer node, @NotNull Language language, @NotNull TemplateSet templateSet)
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.getAlternativeUrls(ContentProducer, Language, TemplateSet)
@Nullable String getStoredUrl(@NotNull SiteStoreFolder folder, @NotNull Language language, @NotNull TemplateSet templateSet)
folder
- Node to get the URL for.language
- Language to get the URL for.templateSet
- TemplateSet to get the URL for.null
if no URL is stored (yet).NullPointerException
- if either parameter folder
, language
, or templateSet
is null
.setStoredUrl(String, SiteStoreFolder, Language, TemplateSet)
,
SiteStoreFolder.getStoredUrl(Language, TemplateSet)
void setStoredUrl(@Nullable String url, @NotNull SiteStoreFolder folder, @NotNull Language language, @NotNull TemplateSet templateSet)
url
- url to set (may be null
).folder
- Folder to set the URL for.language
- Language to set the URL for.templateSet
- TemplateSet to set the URL for.NullPointerException
- if either parameter folder
, language
, or templateSet
is null
.getStoredUrl(SiteStoreFolder, Language, TemplateSet)
@Nullable String getStoredUrl(@NotNull MediaFolder folder, @NotNull Language language)
folder
- Folder to get the URL for.language
- Language to get the URL for.null
if no URL is stored (yet).NullPointerException
- if either parameter node
or language
is null
.setStoredUrl(String, MediaFolder, Language)
,
MediaFolder.getStoredUrl(Language)
void setStoredUrl(@Nullable String url, @NotNull MediaFolder folder, @NotNull Language language)
url
- url to set (may be null
).folder
- Folder to set the URL for.language
- Language to set the URL for.NullPointerException
- if either parameter folder
or language
is null
.getStoredUrl(MediaFolder, Language)
@Nullable String getStoredUrl(@NotNull Media node, @Nullable Language language, @Nullable Resolution resolution)
node
- Node to get the URL for.language
- Language to get the URL for. May be null
for language independent media nodes.resolution
- Resolution to get the URL for. Could be null
for media nodes of type
Media.FILE
.null
if no URL is stored (yet).NullPointerException
- if node
is null
or if parameter language
is null
and
provided node is language dependent
or parameter resolution
is
null
and this node is of type
Media.PICTURE
.setStoredUrl(String, Media, Language, Resolution)
,
Media.getStoredUrl(Language, Resolution)
void setStoredUrl(@Nullable String url, @NotNull Media node, @Nullable Language language, @Nullable Resolution resolution)
url
- url to set (may be null
).node
- Node to set the URL for.language
- Language to get the URL for. May be null
for language independent media nodes.resolution
- Resolution to set the URL for. May be null
for media nodes of type
Media.FILE
.NullPointerException
- if node
is null
or if parameter language
is null
and
provided node is language dependent
or parameter resolution
is
null
and this node is of type
Media.PICTURE
.getStoredUrl(Media, Language, Resolution)
int resetStoredUrls(@NotNull IDProvider node)
The node must be locked
when this method is called.
node
- node of type PageRef
, DocumentGroup
, PageFolder
, or Media
.Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500