Package de.hybris.platform.cockpit.services.celum

Interface CockpitCelumService

  • public interface CockpitCelumService
    Service providing the Cockpit framework with Celum specific functionality.

    • Method Detail

      • getDirectCelumLink

        java.lang.String getDirectCelumLink​(ItemModel item,
                                    java.lang.String celumAssetId,
                                    java.util.Map<java.lang.String,​java.lang.String> params)
        Returns a link to be used for opening Celum Imagine from within a Cockpit application.
        Parameters:
        item - default search parameters for this item type will be included in returned link (leave null if no search parameters should be included)
        celumAssetId - celum asset id
        params - custom parameters, some of which are echoed back to the cockpit
        Returns:
        the link to be used for opening Celum Imagine

      • getDirectCelumLink

        java.lang.String getDirectCelumLink​(java.lang.String celumAssetId,
                                    java.util.Map<java.lang.String,​java.lang.String> params)
        Returns a link to be used for opening Celum Imagine from within a Cockpit application.
        Parameters:
        celumAssetId - celum asset id
        params - custom parameters, some of which are echoed back to the cockpit
        Returns:
        the link to be used for opening Celum Imagine

      • getCelumUrl

        java.lang.String getCelumUrl​(TypedObject celumAsset)
                      throws java.lang.IllegalArgumentException
        Returns the Celum URL of the specified Celum asset.
        Parameters:
        celumAsset - celum asset
        Returns:
        the URL for displaying the Celum asset
        Throws:
        java.lang.IllegalArgumentException - if celumAsset is null
        See Also:
        getLocalUrl(TypedObject)

      • getLocalUrl

        java.lang.String getLocalUrl​(TypedObject celumAsset)
                      throws java.lang.IllegalArgumentException
        Returns the local URL of the specified Celum asset.
        Parameters:
        celumAsset - celum asset
        Returns:
        the URL for displaying the local version of the Celum asset
        Throws:
        java.lang.IllegalArgumentException - if celumAsset is null
        See Also:
        getCelumUrl(TypedObject)

      • synchronize

        void synchronize​(TypedObject celumAsset)
        Synchronize.
        Parameters:
        celumAsset - the celum asset

      • unSynchronize

        void unSynchronize​(TypedObject celumAsset)
        Unsynchronize CelumAsset.
        Parameters:
        celumAsset - the celum asset

      • isSynchronized

        boolean isSynchronized​(TypedObject celumAsset)
                throws java.lang.IllegalArgumentException
        Checks if is CelumAsset is synchronized.
        Parameters:
        celumAsset - the celum asset
        Returns:
        true, if is synchronized
        Throws:
        java.lang.IllegalArgumentException - the illegal argument exception

      • isAssetValid

        boolean isAssetValid​(TypedObject celumAsset)
        Checks if is asset valid.
        Parameters:
        celumAsset - the celum asset
        Returns:
        true, if is asset valid

      • isCelumAlive

        java.lang.Boolean isCelumAlive()
        Checks if celum server is alive and responding.
        Returns:
        true, if is celum alive

      • getOriginalMediaFormat

        java.lang.String getOriginalMediaFormat()
        Gets the original media format.
        Returns:
        the original media format

      • getCelumAssetId

        java.lang.Integer getCelumAssetId​(ItemModel asset)
        Parameters:
        asset - item model which might be celum asset
        Returns:
        celum asset id if given item is existing celum asset or null.