Interface IContentManagementSystem
- All Superinterfaces:
ContentManagementSystem
,ch.ivyteam.ivy.cm.IContentManagementEntity
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
addSupportedLanguage
(Locale language) Deprecated, for removal: This API element is subject to removal in a future version.useless.Returns the value of the content object with the given URI in the currently active language.Returns the value of the ContentObject at the given URI in the currently active language.Returns the value of the ContentObject in the given language.Returns the value of the ContentObject in the given language.Returns a reference to the content object with the given URI.findContentObject
(String uri) Deprecated, for removal: This API element is subject to removal in a future version.Use ivy.cm.findObject(String) instead
Migration Example:ivy.cms.findContentObject("/my/content")
==>ivy.cm.findObject("/my/content").orElse(null)
default IContentObjectValue
findContentObjectValue
(String uri, Locale language) Deprecated, for removal: This API element is subject to removal in a future version.use ivy.cm.findValue(String) instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH)
==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)
default IContentObject
getContentObject
(Object key) Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default IContentObject
getContentObject
(String uri) Deprecated, for removal: This API element is subject to removal in a future version.default IContentObject
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default IContentObjectValue
getContentObjectValue
(String uri, Locale language) Deprecated, for removal: This API element is subject to removal in a future version.useContentManagementSystem.get(String)
,ContentObject.value()
andContentObjectValueAccessor.get(Locale)
instead
Migration Example:ivy.cms.getContentObjectValue("/my/content", Locale.ENGLISH)
==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)
default Locale
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default IContentObject
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default IContentObject
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default String
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default Object
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default String
getName()
Deprecated, for removal: This API element is subject to removal in a future version.the name of the cms is always the same (cms).default IContentObject
Deprecated, for removal: This API element is subject to removal in a future version.default boolean
isSupportedLanguage
(Locale language) Deprecated, for removal: This API element is subject to removal in a future version.useless.default void
removeSupportedLanguage
(Locale language) Deprecated, for removal: This API element is subject to removal in a future version.useless.default void
setDefaultLanguage
(Locale defaultLanguage) Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default void
setDefaultPageLayout
(IContentObject defaultLayout) Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.default void
setDefaultPageStyleSheet
(IContentObject defaultStyleSheet) Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore.Methods inherited from interface ch.ivyteam.ivy.cm.ContentManagementSystem
get, locales, root
-
Method Details
-
getName
Deprecated, for removal: This API element is subject to removal in a future version.the name of the cms is always the same (cms).- API:
- This public API is available in Java.
-
getDescription
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. always returns empty string.- API:
- This public API is available in Java.
-
addSupportedLanguage
Deprecated, for removal: This API element is subject to removal in a future version.useless. all languages are supported by any cms. calling this method has no effect.- API:
- This public API is available in Java.
-
removeSupportedLanguage
Deprecated, for removal: This API element is subject to removal in a future version.useless. all languages are supported by any cms. calling this method has no effect.- API:
- This public API is available in Java.
-
isSupportedLanguage
Deprecated, for removal: This API element is subject to removal in a future version.useless. all languages are supported by any cms.- API:
- This public API is available in Java.
-
getDefaultLanguage
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. always returns null;- API:
- This public API is available in Java.
-
setDefaultLanguage
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. calling this method has no effect.- API:
- This public API is available in Java.
-
setDefaultPageLayout
@Deprecated(since="9.3", forRemoval=true) default void setDefaultPageLayout(IContentObject defaultLayout) Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. calling this method has no effect.- API:
- This public API is available in Java.
-
setDefaultPageStyleSheet
@Deprecated(since="9.3", forRemoval=true) default void setDefaultPageStyleSheet(IContentObject defaultStyleSheet) Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. calling this method has no effect.- API:
- This public API is available in Java.
-
getDefaultPageLayout
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. always returns null.- API:
- This public API is available in Java.
-
getDefaultPageStyleSheet
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. always returns null.- API:
- This public API is available in Java.
-
findContentObject
Deprecated, for removal: This API element is subject to removal in a future version.Use ivy.cm.findObject(String) instead
Migration Example:ivy.cms.findContentObject("/my/content")
==>ivy.cm.findObject("/my/content").orElse(null)
- API:
- This public API is available in Java.
-
getContentObject
Deprecated, for removal: This API element is subject to removal in a future version.- API:
- This public API is available in Java.
-
findContentObjectValue
@Deprecated(since="9.4", forRemoval=true) default IContentObjectValue findContentObjectValue(String uri, Locale language) Deprecated, for removal: This API element is subject to removal in a future version.use ivy.cm.findValue(String) instead
Migration Example:ivy.cms.findContentObjectValue("/my/content", Locale.ENGLISH)
==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)
- API:
- This public API is available in Java.
-
getContentObjectValue
@Deprecated(since="9.4", forRemoval=true) default IContentObjectValue getContentObjectValue(String uri, Locale language) Deprecated, for removal: This API element is subject to removal in a future version.useContentManagementSystem.get(String)
,ContentObject.value()
andContentObjectValueAccessor.get(Locale)
instead
Migration Example:ivy.cms.getContentObjectValue("/my/content", Locale.ENGLISH)
==>ivy.cm.findValue("/my/content").resolve(Locale.ENGLISH).orElse(null)
- API:
- This public API is available in Java.
-
getContentObject
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. always returns null.- API:
- This public API is available in Java.
-
co
Returns the value of the ContentObject at the given URI in the currently active language. The value is rendered as a String, according to the context and to the type of the value. The placeholders ({0}, {1}, etc.) in the content object value will be replaced by the specified
formatObjects
. The result is dependent on the availability of renderers in the current context and may be the empty String if the value could not be rendered correcly.The search scope is the current case's project or - if not available - this cms'es project and all of it's required projects. If the given uri can not be resolved then the empty String will be returned.
This method never returns null.
- Parameters:
uri
- the uri of the ContentObject to retrieveformatObjects
- The objects that will be used to replace the placeholders in the content object value. E.g. {0} will be replaced by the first object in the specified list, {1} with the second object and so on.- Returns:
- rendered String of ContentObjectValue with given uri in current language or the empty String (never null)
- API:
- This public API is available in Java.
-
coLocale
Returns the value of the ContentObject in the given language. The value is rendered as a String, according to the context and to the type of the value. The result is dependent on the availability of renderers in the current context and may be the empty String if the value could not be rendered correctly.
The search scope is the current case's project or - if not available - this cms'es project and all of it's required projects. If the given uri can not be resolved then the empty String will be returned.
This method returns never
null
.- Parameters:
uri
- the uri of the ContentObject to retrievelocale
- the preferred language for the value- Returns:
- rendered String of ContentObjectValue with given uri in current language or the empty String (never null)
- Since:
- 6.4.0
- API:
- This public API is available in Java.
-
coLocale
Returns the value of the ContentObject in the given language. The value is rendered as a String, according to the context and to the type of the value. The result is dependent on the availability of renderers in the current context and may be the empty String if the value could not be rendered correctly.
The search scope is the current case's project or - if not available - this cms'es project and all of it's required projects. If the given uri can not be resolved then the empty String will be returned.
This method returns never
null
.- Parameters:
uri
- the uri of the ContentObject to retrievelocale
- the preferred language for the value. E.g. 'de_DE', 'de_CH', 'fr' or 'en'.- Returns:
- rendered String of ContentObjectValue with given uri in current language or the empty String (never null)
- Since:
- 6.4.0
- API:
- This public API is available in Java.
-
co
Returns the value of the content object with the given URI in the currently active language. The value is rendered as a string. SeefindContentObject(String)
to learn how the value is resolved.- Parameters:
uri
- cms uri- Returns:
- content as string
- API:
- This public API is available in Java.
-
cr
Returns a reference to the content object with the given URI. SeefindContentObject(String)
to learn how the reference is resolved.- Parameters:
uri
- the uri of the content object to get a reference of- Returns:
- reference
- API:
- This public API is available in Java.
-
getIdentifier
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. always returns null.- API:
- This public API is available in Java.
-
getContentObjectForKey
Deprecated, for removal: This API element is subject to removal in a future version.not supported anymore. always returns null.- API:
- This public API is available in Java.
-
getRootContentObject
Deprecated, for removal: This API element is subject to removal in a future version.- API:
- This public API is available in Java.
-