Package org.cyclos.services.contentmanagement

Interface InternalUiService

  • All Superinterfaces:
    Service
    All Known Subinterfaces:
    InternalUiServiceLocal
    public interface InternalUiService
extends Service
    Service used by the REST API to get data for an alternative UI

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      UiData getData​(ThemeType type, boolean isThemeByComponents, Long deviceId, PinLocatorVO pinLocator, GetVersionedDataParams params)
      Return data containing the configuration for the current user or guest if there is no logged user.
      In case of the content data (i.e header / footer / theme) it's returned only if it has changed regarding the given cache control (i.

    • Method Detail

      • getData

        UiData getData​(ThemeType type,
               boolean isThemeByComponents,
               Long deviceId,
               PinLocatorVO pinLocator,
               GetVersionedDataParams params)
        Return data containing the configuration for the current user or guest if there is no logged user.
        In case of the content data (i.e header / footer / theme) it's returned only if it has changed regarding the given cache control (i. e GetVersionedDataParams).
        Parameters:
        deviceId - (Optional) the trusted device id to query if it's still exists.
        pinLocator - (Optional) the device pin locator to query if it's still exists.
        isThemeByComponents - flag used to indicate how the theme must be returned: by its CSS content (false) or by its components (true): base definitions, advanced definitions and custom style.
        params - Required. The current version the client has for the content data. If we want to force get the data then invoke this method with an empty instance (not null).