Interface CockpitCelumService
public interface CockpitCelumService
Service providing the Cockpit framework with Celum specific functionality.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiongetCelumAssetId(ItemModel asset) getCelumUrl(TypedObject celumAsset) Returns the Celum URL of the specified Celum asset.Returns a link to be used for opening Celum Imagine from within a Cockpit application.getDirectCelumLink(String celumAssetId, Map<String, String> params) Returns a link to be used for opening Celum Imagine from within a Cockpit application.getLocalUrl(TypedObject celumAsset) Returns the local URL of the specified Celum asset.Gets the original media format.booleanisAssetValid(TypedObject celumAsset) Checks if is asset valid.Checks if celum server is alive and responding.booleanisSynchronized(TypedObject celumAsset) Checks if is CelumAsset is synchronized.voidsynchronize(TypedObject celumAsset) Synchronize.voidunSynchronize(TypedObject celumAsset) Unsynchronize CelumAsset.
-
Field Details
-
REQUEST_EVENT_PREFIX
- See Also:
-
CELUM_CONTAINER_KEY
- See Also:
-
-
Method Details
-
getDirectCelumLink
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 (leavenullif no search parameters should be included)celumAssetId- celum asset idparams- custom parameters, some of which are echoed back to the cockpit- Returns:
- the link to be used for opening Celum Imagine
-
getDirectCelumLink
Returns a link to be used for opening Celum Imagine from within a Cockpit application.- Parameters:
celumAssetId- celum asset idparams- custom parameters, some of which are echoed back to the cockpit- Returns:
- the link to be used for opening Celum Imagine
-
getCelumUrl
Returns the Celum URL of the specified Celum asset.- Parameters:
celumAsset- celum asset- Returns:
- the URL for displaying the Celum asset
- Throws:
IllegalArgumentException- ifcelumAssetisnull- See Also:
-
getLocalUrl
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:
IllegalArgumentException- ifcelumAssetis null- See Also:
-
synchronize
Synchronize.- Parameters:
celumAsset- the celum asset
-
unSynchronize
Unsynchronize CelumAsset.- Parameters:
celumAsset- the celum asset
-
isSynchronized
Checks if is CelumAsset is synchronized.- Parameters:
celumAsset- the celum asset- Returns:
- true, if is synchronized
- Throws:
IllegalArgumentException- the illegal argument exception
-
isAssetValid
Checks if is asset valid.- Parameters:
celumAsset- the celum asset- Returns:
- true, if is asset valid
-
isCelumAlive
Boolean isCelumAlive()Checks if celum server is alive and responding.- Returns:
- true, if is celum alive
-
getOriginalMediaFormat
String getOriginalMediaFormat()Gets the original media format.- Returns:
- the original media format
-
getCelumAssetId
- Parameters:
asset- item model which might be celum asset- Returns:
- celum asset id if given item is existing celum asset or null.
-