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

Interface CockpitCelumDelegate

  • All Known Implementing Classes:
    DefaultCockpitCelumDelegate
    public interface CockpitCelumDelegate
    Cockpit Celum Business delegate. Provides the Cockpit framework with miscellaneous MAM/Celum functionality.

    • Method Detail

      • isCelumAvailable

        boolean isCelumAvailable()
        Returns whether Celum is available and ready to be used.
        Returns:
        true if Celum is available, false otherwise

      • getCelumLink

        java.lang.String getCelumLink​(ItemModel item,
                              java.lang.String celumAssetId,
                              java.util.Map<java.lang.String,​java.lang.String> params)
                       throws CelumNotAvailableException
        Returns a link to be used when opening Celum Imagine from within a Cockpit application.

        Note: Make sure to call isCelumAvailable() before calling this method.

        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 (leave null if no ID is available)
        params - custom parameters, some of which are echoed back to the Cockpit
        Returns:
        the link to be used for opening Celum Imagine
        Throws:
        CelumNotAvailableException - if MAM/Celum is not available

      • getCelumLink

        java.lang.String getCelumLink​(java.lang.String celumAssetId,
                              java.util.Map<java.lang.String,​java.lang.String> params)
                       throws CelumNotAvailableException
        Returns a link to be used when opening Celum Imagine from within a Cockpit application.

        Note: Make sure to call isCelumAvailable() before calling this method.

        Parameters:
        celumAssetId - celum asset ID (leave null if no ID is available)
        params - custom parameters, some of which are echoed back to the Cockpit
        Returns:
        the link to be used for opening Celum Imagine
        Throws:
        CelumNotAvailableException - if MAM/Celum is not available

      • createSynchPopup

        void createSynchPopup​(org.zkoss.zk.ui.Component button,
                      TypedObject celumAsset,
                      EditorListener listener)
               throws CelumNotAvailableException,
                      java.lang.IllegalArgumentException
        Creates a Celum Asset Synchronization popup dialog to be used in a Cockpit.

        Note: This method will add an event listener to the button, registered for handling ZK " onClick events.

        Parameters:
        button - the button which should open the synchronization dialog
        celumAsset - the celum asset
        listener - the editor listener
        Throws:
        CelumNotAvailableException - if MAM/Celum is not available
        java.lang.IllegalArgumentException - if celumAsset is null

      • getMediaUrl

        java.lang.String getMediaUrl​(TypedObject celumAsset)
                      throws CelumNotAvailableException,
                             java.lang.IllegalArgumentException
        Returns the URL of the current Celum version of the Celum asset.
        Parameters:
        celumAsset - the celum asset
        Returns:
        the URL of the current Celum asset version
        Throws:
        CelumNotAvailableException - if MAM/Celum is not available
        java.lang.IllegalArgumentException - if celumAsset is null
        See Also:
        getLocalMediaUrl(TypedObject)

      • getLocalMediaUrl

        java.lang.String getLocalMediaUrl​(TypedObject celumAsset)
                           throws CelumNotAvailableException,
                                  java.lang.IllegalArgumentException
        Returns the URL of the local version of the Celum asset.
        Parameters:
        celumAsset - the celum asset
        Returns:
        the URL of the local Celum asset version
        Throws:
        CelumNotAvailableException - if MAM/Celum is not available
        java.lang.IllegalArgumentException - if celumAsset is null
        See Also:
        getMediaUrl(TypedObject)

      • isSynchronized

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

      • synchronize

        void synchronize​(TypedObject celumAsset)
          throws CelumNotAvailableException,
                 java.lang.IllegalArgumentException
        Synchronize celum asset with current image in celum.
        Parameters:
        celumAsset - the celum asset
        Throws:
        CelumNotAvailableException - the celum not available exception
        java.lang.IllegalArgumentException - the illegal argument exception

      • unSynchronize

        void unSynchronize​(TypedObject celumAsset)
            throws CelumNotAvailableException,
                   java.lang.IllegalArgumentException
        Un synchronize.
        Parameters:
        celumAsset - the celum asset
        Throws:
        CelumNotAvailableException - the celum not available exception
        java.lang.IllegalArgumentException - the illegal argument exception

      • 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.