Package ch.ivyteam.ivy.cm

Interface IContentManagementSystem

All Superinterfaces:
ContentManagementSystem, ch.ivyteam.ivy.cm.IContentManagementEntity
public interface IContentManagementSystem extends ContentManagementSystem, ch.ivyteam.ivy.cm.IContentManagementEntity
The Ivy Content Management System (CMS). The CMS is a container for various types of content. Content can be put in the CMS as name-tuple pairs where as a tuple consists of a value in the configured languages of the CMS.
API:
This is a public API.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    co(String uri)
    Returns the value of the content object with the given URI in the currently active language.
    String
    co(String uri, List<Object> formatObjects)
    Returns the value of the ContentObject at the given URI in the currently active language.
    String
    coLocale(String uri, String locale)
    Returns the value of the ContentObject in the given language.
    String
    coLocale(String uri, Locale locale)
    Returns the value of the ContentObject in the given language.
    String
    cr(String uri)
    Returns a reference to the content object with the given URI.

    Methods inherited from interface ch.ivyteam.ivy.cm.ContentManagementSystem

    get, locales, root

  • Method Details

    • co

      String co(String uri, List<Object> formatObjects)

      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 retrieve
      formatObjects - 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 IvyScript and Java. It has the visibility NOVICE.

    • coLocale

      String coLocale(String uri, Locale locale)

      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 retrieve
      locale - 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 IvyScript and Java. It has the visibility NOVICE.

    • coLocale

      String coLocale(String uri, String locale)

      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 retrieve
      locale - 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 IvyScript and Java. It has the visibility NOVICE.

    • co

      String co(String uri)
      Returns the value of the content object with the given URI in the currently active language. The value is rendered as a string. See findContentObject(String) to learn how the value is resolved.
      Parameters:
      uri - cms uri
      Returns:
      content as string
      API:
      This public API is available in IvyScript and Java. It has the visibility NOVICE.

    • cr

      String cr(String uri)
      Returns a reference to the content object with the given URI. See findContentObject(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 IvyScript and Java. It has the visibility NOVICE.