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

Class DefaultCockpitCelumDelegate

java.lang.Object

de.hybris.platform.cockpit.services.celum.impl.DefaultCockpitCelumDelegate

All Implemented Interfaces:

CockpitCelumDelegate

public class DefaultCockpitCelumDelegate
extends java.lang.Object
implements CockpitCelumDelegate

Constructor Summary

Constructors

Constructor	Description
DefaultCockpitCelumDelegate()

Method Summary

Modifier and Type	Method	Description
void	createSynchPopup(org.zkoss.zk.ui.Component button, TypedObject celumAsset, EditorListener listener)	Creates a Celum Asset Synchronization popup dialog to be used in a Cockpit.
java.lang.Integer	getCelumAssetId(ItemModel asset)
java.lang.String	getCelumLink(ItemModel item, java.lang.String celumAssetId, java.util.Map<java.lang.String,java.lang.String> params)	Returns a link to be used when opening Celum Imagine from within a Cockpit application.
java.lang.String	getCelumLink(java.lang.String celumAssetId, java.util.Map<java.lang.String,java.lang.String> params)	Returns a link to be used when opening Celum Imagine from within a Cockpit application.
protected CockpitCelumService	getCockpitCelumService()
java.lang.String	getLocalMediaUrl(TypedObject celumAsset)	Returns the URL of the local version of the Celum asset.
java.lang.String	getMediaUrl(TypedObject celumAsset)	Returns the URL of the current Celum version of the Celum asset.
java.lang.String	getOriginalMediaFormat()	Gets the original media format.
boolean	isCelumAssetValid(TypedObject celumAsset)	Checks if is celum asset valid.
boolean	isCelumAvailable()	Returns whether Celum is available and ready to be used.
boolean	isSynchronized(TypedObject celumAsset)	Checks if is synchronized.
void	synchronize(TypedObject celumAsset)	Synchronize celum asset with current image in celum.
void	unSynchronize(TypedObject celumAsset)	Un synchronize.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCockpitCelumDelegate

public DefaultCockpitCelumDelegate()

Method Detail

isCelumAvailable

public boolean isCelumAvailable()

Description copied from interface: CockpitCelumDelegate

Returns whether Celum is available and ready to be used.

Specified by:

isCelumAvailable in interface CockpitCelumDelegate

Returns:

true if Celum is available, false otherwise

getCelumLink

public java.lang.String getCelumLink(ItemModel item,
                                     java.lang.String celumAssetId,
                                     java.util.Map<java.lang.String,java.lang.String> params)
                              throws CelumNotAvailableException

Description copied from interface: CockpitCelumDelegate

Returns a link to be used when opening Celum Imagine from within a Cockpit application.

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

Specified by:

getCelumLink in interface CockpitCelumDelegate

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

public java.lang.String getCelumLink(java.lang.String celumAssetId,
                                     java.util.Map<java.lang.String,java.lang.String> params)
                              throws CelumNotAvailableException

Description copied from interface: CockpitCelumDelegate

Returns a link to be used when opening Celum Imagine from within a Cockpit application.

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

Specified by:

getCelumLink in interface CockpitCelumDelegate

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

getCockpitCelumService

protected CockpitCelumService getCockpitCelumService()

createSynchPopup

public void createSynchPopup(org.zkoss.zk.ui.Component button,
                             TypedObject celumAsset,
                             EditorListener listener)
                      throws CelumNotAvailableException,
                             java.lang.IllegalArgumentException

Description copied from interface: CockpitCelumDelegate

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.

Specified by:

createSynchPopup in interface CockpitCelumDelegate

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

getLocalMediaUrl

public java.lang.String getLocalMediaUrl(TypedObject celumAsset)
                                  throws CelumNotAvailableException,
                                         java.lang.IllegalArgumentException

Description copied from interface: CockpitCelumDelegate

Returns the URL of the local version of the Celum asset.

Specified by:

getLocalMediaUrl in interface CockpitCelumDelegate

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:

CockpitCelumDelegate.getMediaUrl(TypedObject)

getMediaUrl

public java.lang.String getMediaUrl(TypedObject celumAsset)
                             throws CelumNotAvailableException,
                                    java.lang.IllegalArgumentException

Description copied from interface: CockpitCelumDelegate

Returns the URL of the current Celum version of the Celum asset.

Specified by:

getMediaUrl in interface CockpitCelumDelegate

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:

CockpitCelumDelegate.getLocalMediaUrl(TypedObject)

unSynchronize

public void unSynchronize(TypedObject celumAsset)
                   throws CelumNotAvailableException,
                          java.lang.IllegalArgumentException

Description copied from interface: CockpitCelumDelegate

Un synchronize.

Specified by:

unSynchronize in interface CockpitCelumDelegate

Parameters:

celumAsset - the celum asset

Throws:

CelumNotAvailableException - the celum not available exception

java.lang.IllegalArgumentException - the illegal argument exception

synchronize

public void synchronize(TypedObject celumAsset)
                 throws CelumNotAvailableException,
                        java.lang.IllegalArgumentException

Description copied from interface: CockpitCelumDelegate

Synchronize celum asset with current image in celum.

Specified by:

synchronize in interface CockpitCelumDelegate

Parameters:

celumAsset - the celum asset

Throws:

CelumNotAvailableException - the celum not available exception

java.lang.IllegalArgumentException - the illegal argument exception

isSynchronized

public boolean isSynchronized(TypedObject celumAsset)
                       throws CelumNotAvailableException,
                              java.lang.IllegalArgumentException

Description copied from interface: CockpitCelumDelegate

Checks if is synchronized.

Specified by:

isSynchronized in interface CockpitCelumDelegate

Parameters:

celumAsset - the celum asset

Returns:

true, if is synchronized

Throws:

CelumNotAvailableException - the celum not available exception

java.lang.IllegalArgumentException - the illegal argument exception

isCelumAssetValid

public boolean isCelumAssetValid(TypedObject celumAsset)
                          throws CelumNotAvailableException

Description copied from interface: CockpitCelumDelegate

Checks if is celum asset valid.

Specified by:

isCelumAssetValid in interface CockpitCelumDelegate

Parameters:

celumAsset - the celum asset

Returns:

true, if is celum asset valid

Throws:

CelumNotAvailableException - the celum not available exception

getOriginalMediaFormat

public java.lang.String getOriginalMediaFormat()
                                        throws CelumNotAvailableException

Description copied from interface: CockpitCelumDelegate

Gets the original media format.

Specified by:

getOriginalMediaFormat in interface CockpitCelumDelegate

Returns:

the original media format

Throws:

CelumNotAvailableException - the celum not available exception

getCelumAssetId

public java.lang.Integer getCelumAssetId(ItemModel asset)

Specified by:

getCelumAssetId in interface CockpitCelumDelegate

Parameters:

asset - item model which might be celum asset

Returns:

celum asset id if given item is existing celum asset or null.