Interface CockpitCelumDelegate
- All Known Implementing Classes:
DefaultCockpitCelumDelegate
public interface CockpitCelumDelegate
Cockpit Celum Business delegate. Provides the Cockpit framework with miscellaneous MAM/Celum functionality.
-
Method Summary
Modifier and TypeMethodDescriptionvoidcreateSynchPopup(org.zkoss.zk.ui.Component button, TypedObject celumAsset, EditorListener listener) Creates a Celum Asset Synchronization popup dialog to be used in a Cockpit.getCelumAssetId(ItemModel asset) Returns a link to be used when opening Celum Imagine from within a Cockpit application.getCelumLink(String celumAssetId, Map<String, String> params) Returns a link to be used when opening Celum Imagine from within a Cockpit application.getLocalMediaUrl(TypedObject celumAsset) Returns the URL of the local version of the Celum asset.getMediaUrl(TypedObject celumAsset) Returns the URL of the current Celum version of the Celum asset.Gets the original media format.booleanisCelumAssetValid(TypedObject celumAsset) Checks if is celum asset valid.booleanReturns whether Celum is available and ready to be used.booleanisSynchronized(TypedObject celumAsset) Checks if is synchronized.voidsynchronize(TypedObject celumAsset) Synchronize celum asset with current image in celum.voidunSynchronize(TypedObject celumAsset) Un synchronize.
-
Method Details
-
isCelumAvailable
boolean isCelumAvailable()Returns whether Celum is available and ready to be used.- Returns:
trueif Celum is available,falseotherwise
-
getCelumLink
String getCelumLink(ItemModel item, String celumAssetId, Map<String, String> params) throws CelumNotAvailableExceptionReturns a link to be used when opening Celum Imagine from within a Cockpit application. Note: Make sure to callisCelumAvailable()before calling this method.- Parameters:
item- default search parameters for this item type will be included in returned link (leavenullif no search parameters should be included)celumAssetId- celum asset ID (leavenullif 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
String getCelumLink(String celumAssetId, Map<String, String> params) throws CelumNotAvailableExceptionReturns a link to be used when opening Celum Imagine from within a Cockpit application. Note: Make sure to callisCelumAvailable()before calling this method.- Parameters:
celumAssetId- celum asset ID (leavenullif 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, 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 "onClickevents.- Parameters:
button- the button which should open the synchronization dialogcelumAsset- the celum assetlistener- the editor listener- Throws:
CelumNotAvailableException- if MAM/Celum is not availableIllegalArgumentException- ifcelumAssetisnull
-
getMediaUrl
String getMediaUrl(TypedObject celumAsset) throws CelumNotAvailableException, 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 availableIllegalArgumentException- ifcelumAssetisnull- See Also:
-
getLocalMediaUrl
String getLocalMediaUrl(TypedObject celumAsset) throws CelumNotAvailableException, 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 availableIllegalArgumentException- ifcelumAssetisnull- See Also:
-
isSynchronized
boolean isSynchronized(TypedObject celumAsset) throws CelumNotAvailableException, IllegalArgumentException Checks if is synchronized.- Parameters:
celumAsset- the celum asset- Returns:
- true, if is synchronized
- Throws:
CelumNotAvailableException- the celum not available exceptionIllegalArgumentException- the illegal argument exception
-
synchronize
void synchronize(TypedObject celumAsset) throws CelumNotAvailableException, IllegalArgumentException Synchronize celum asset with current image in celum.- Parameters:
celumAsset- the celum asset- Throws:
CelumNotAvailableException- the celum not available exceptionIllegalArgumentException- the illegal argument exception
-
unSynchronize
void unSynchronize(TypedObject celumAsset) throws CelumNotAvailableException, IllegalArgumentException Un synchronize.- Parameters:
celumAsset- the celum asset- Throws:
CelumNotAvailableException- the celum not available exceptionIllegalArgumentException- the illegal argument exception
-
isCelumAssetValid
Checks if is celum asset valid.- Parameters:
celumAsset- the celum asset- Returns:
- true, if is celum asset valid
- Throws:
CelumNotAvailableException- the celum not available exception
-
getOriginalMediaFormat
Gets the original media format.- Returns:
- the original media format
- Throws:
CelumNotAvailableException- the celum not available exception
-
getCelumAssetId
- Parameters:
asset- item model which might be celum asset- Returns:
- celum asset id if given item is existing celum asset or null.
-