Package mc.core.domain.asset.dobj

Class AssetDO

java.lang.Object

mc.core.system.base.BaseBean

mc.core.domain.base.dobj.AbstractBaseDO<T>

mc.core.domain.base.dobj.AbstractEntityBaseDO<T>

mc.core.domain.base.dobj.AbstractComplexEntityDO<S>

mc.core.domain.asset.dobj.AbstractAssetDO<Asset,Asset>

mc.core.domain.asset.dobj.AssetDO

All Implemented Interfaces:

IBaseDO<Asset>

public class AssetDO
extends AbstractAssetDO<Asset,Asset>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AssetDO.AssetEvent

Nested classes/interfaces inherited from class mc.core.domain.base.dobj.AbstractBaseDO

AbstractBaseDO.Initializer

Constructor Summary

Constructors

Constructor	Description
AssetDO()

Method Summary

Modifier and Type	Method	Description
void	changeType(List<Asset> assets, AssetType targetAssetType)	Changes type of assets.
mc.core.system.workflow.ActionParameterList	changeTypeSync(List<Asset> assets, AssetType targetAssetType)	Changes type of assets.
void	convert(List<Asset> assets)
void	convert(Asset asset)
List<Asset>	copy(List<Asset> sourceAssets, Collection targetCollection)
Asset	copy(Asset source, Collection targetCollection)
Asset	copy(Asset source, Collection targetCollection, AssetCopyFilter copyFilter)
Asset	copyToCollection(Asset source, Collection targetCollection)	create a copy of given source entity in parentCollection if given
void	delete(Asset asset, boolean force)	NOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!
void	deleteList(List<Asset> assets, boolean force)	MC-7160 delete list of assets asynchrony
void	deleteOrRecycle(Asset asset, boolean force, boolean collectionBeDeleted)	case 1: asset is visible --> recycle and move in recycleBin collection if not null or asset keep the original collection case 2: asset is not visible and deleteCollection is true (only collection be deleted, the assets from it (recycled too) still in recycle bin --> only move asset in recycleBin collection case 3: asset is not visible and deleteCollection is false --> remove asset from system
void	deleteRecycled(Asset asset, boolean force)	MC-22124 delete recycled objects explicitly.
void	deleteSync(Asset entity)
void	derivateDelete(List<AssetDerivate> derivates)
void	derivateDelete(AssetDerivate derivate)
List<Asset>	getGroupAssets(Asset master, String assetGroupId, Asset.AssetGroupRole roleToSearch, boolean onlyVisible)
Collection	getRootCollection()
void	groupAddVariant(Asset variant, Asset leader)
void	groupChangeRole(Asset asset, Asset.AssetGroupRole targetRole)
void	groupCreate(Asset master)
Asset	groupDeleteLatestVersion(Asset asset)	MC-5555 delete last version of asset the role of the deleted will be transferred to the previous VISIBLE version (if any) WARNING: case asset has role LEADER and has no versions - redirect to delete - remove asset with variants and its versions case asset has role VERSION - remove this version, return null case asset has no versions - redirect to delete - return null
List<Asset>	groupGetAssets(String assetGroupId, Asset.AssetGroupRole roleToSearch)
Asset	groupGetLeader(Asset variant)
Asset	groupGetMaster(Asset version)
List<Asset>	groupGetVersions(Asset master)
Asset	groupInsertVariant(AssetInsertParameter param)
Asset	groupInsertVersion(AssetInsertParameter param, boolean makeActive)
void	groupReassignValues(Asset source, Asset target, boolean deleteSource)	MC-5480 all assignment to attribute values (DTAsset) be migrate to new version
void	groupRemove(Asset leader)
void	groupRemoveAsset(Asset asset)
AssetInsertResult	insert(AssetInsertParameter param)	special insert for asset with parameter object
Asset	insert(Asset entity)
AssetInsertResult	insertExternal(AssetInsertParameter assetInsertParameter, String externalURI)
AssetInsertResult	insertExternal(Asset asset, Collection collection, String externalURI, AssetType assetType, boolean overwrite)	Deprecated.
void	move(List<Asset> sourceAssets, Collection targetCollection)	Moves assets, alters primary collection.
Asset	move(Asset source, Collection targetCollection)	Move asset, recoding the change in the change history.
Asset	move(Asset source, Collection targetCollection, boolean reportChange)
void	preview(Asset asset, String format, String templateName, OutputStream os)
void	primaryCollectionChange(Asset asset, Collection newPrimaryCollection)	Sets newPrimaryCollection as primary collection.
void	recycle(Asset asset, boolean force)	recycle asset with group versions if any by group leader: recycle all group variants with its group versions too (see MC-4846)
String	recycledGetOriginalPath(Asset asset)
void	recycleRestore(Asset asset)	restore asset with it versions if any by group leader: restore all group variants with its group versions too (see MC-4846)
void	replaceFile(Asset asset, InputStream fileStream, String filename)
Asset	save(Asset entity, DataMap dataMap)	map data to entity if any, validate and save
void	sendEventOnExport(Asset asset, AssetDerivate derivate, Basket basket)
void	setDerivateFile(Asset asset, InputStream fileStream, String filename, ConverterType converterType)
void	startProcessingWorkflow(Asset asset, List<AssetDerivateType> derivateTypesToCreate)	called from outside by asset convert (user action)
mc.core.domain.asset.dobj.AssetDO.AssetValidator	validator(Asset asset, DataMap map)	for persistent entity copy constructor be used, the copy of entity be mapped and validated WARNING: in error case param map be changed! non valid fields be deleted from it all error be collect as ValidationResults in ValidationException and throw only by validate() call Examples to use: 1.

Methods inherited from class mc.core.domain.asset.dobj.AbstractAssetDO

getContent, getContentFile, getFilename, getFilename, getMetadataValue, getMetadataValues, getMetadataValues, getMetadataValues, setMetadataValues

Methods inherited from class mc.core.domain.base.dobj.AbstractComplexEntityDO

addDefaultSearchCriteria, assertPermission, assertPermission, attributes, copy, copyDataSync, doRecursiveActionAsync, edit, entityProfileApply, entityProfileApply, filter, getCollectionHierarchies, getCollectionsAll, getFromExternalKey, getFromKeySearchFilter, getUserRole, lifecycle, newComplexEntityEvent, onChange, parameter, permissions, prepareSearchFilter, relations, secondaryCollectionAdd, secondaryCollectionCopy, secondaryCollectionMove, secondaryCollectionRemove, setRightInheritanceDisabled, states, translate, versions, watches

Methods inherited from class mc.core.domain.base.dobj.AbstractEntityBaseDO

getFromInternalDescription, sendEvent, sendEvent

Methods inherited from class mc.core.domain.base.dobj.AbstractBaseDO

delete, getAll, getAllActive, getEntityDisplay, getFromId, getFromKey, getOne, map, map, save

Methods inherited from class java.lang.Object

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

Constructor Details

AssetDO

public AssetDO()

Method Details

save

public Asset save(Asset entity,
 DataMap dataMap)
           throws ApplicationException

Description copied from interface: IBaseDO

map data to entity if any, validate and save

Specified by:

save in interface IBaseDO<Asset>

Overrides:

save in class AbstractEntityBaseDO<Asset>

Parameters:

entity - mandatory

dataMap - optional

Returns:

mapped entity

Throws:

ApplicationException

insert

public Asset insert(Asset entity)
             throws ApplicationException

Overrides:

insert in class AbstractComplexEntityDO<Asset>

Throws:

ApplicationException

insert

public AssetInsertResult insert(AssetInsertParameter param)
                         throws ApplicationException

special insert for asset with parameter object

Throws:

ApplicationException

insertExternal

public AssetInsertResult insertExternal(AssetInsertParameter assetInsertParameter,
 String externalURI)
                                 throws ApplicationException

Throws:

ApplicationException

insertExternal

@Deprecated
public AssetInsertResult insertExternal(Asset asset,
 Collection collection,
 String externalURI,
 AssetType assetType,
 boolean overwrite)
                                 throws ApplicationException

Deprecated.

Throws:

ApplicationException

deleteOrRecycle

public void deleteOrRecycle(Asset asset,
 boolean force,
 boolean collectionBeDeleted)
                     throws ApplicationException

case 1: asset is visible --> recycle and move in recycleBin collection if not null or asset keep the original collection case 2: asset is not visible and deleteCollection is true (only collection be deleted, the assets from it (recycled too) still in recycle bin --> only move asset in recycleBin collection case 3: asset is not visible and deleteCollection is false --> remove asset from system

Parameters:

asset -

force -

collectionBeDeleted - if true - indicate only collection be deleted and all assets still in in recycle bin if false - according

Throws:

ApplicationException

deleteRecycled

public void deleteRecycled(Asset asset,
 boolean force)
                    throws ApplicationException

MC-22124 delete recycled objects explicitly. Check assets on visibility

Parameters:

asset -

force -

Throws:

ApplicationException

groupDeleteLatestVersion

public Asset groupDeleteLatestVersion(Asset asset)
                               throws ApplicationException

MC-5555 delete last version of asset
the role of the deleted will be transferred to the previous VISIBLE version (if any)
WARNING:
case asset has role LEADER and has no versions - redirect to delete - remove asset with variants and its versions
case asset has role VERSION - remove this version, return null
case asset has no versions - redirect to delete - return null

Parameters:

asset -

Returns:

the previous VISIBLE version or null

Throws:

ApplicationException

groupReassignValues

public void groupReassignValues(Asset source,
 Asset target,
 boolean deleteSource)
                         throws ApplicationException

MC-5480 all assignment to attribute values (DTAsset) be migrate to new version

Throws:

ApplicationException

delete

public void delete(Asset asset,
 boolean force)
            throws ApplicationException

Description copied from class: AbstractBaseDO

NOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!

Overrides:

delete in class AbstractComplexEntityDO<Asset>

Parameters:

asset - mandatory

force - if true delete without usage check, which can result in db constraints error unless references are taken care of

Throws:

ApplicationException

deleteList

public void deleteList(List<Asset> assets,
 boolean force)
                throws ApplicationException

MC-7160 delete list of assets asynchrony

Throws:

ApplicationException

deleteSync

public void deleteSync(Asset entity)
                throws ApplicationException

Throws:

ApplicationException

recycle

public void recycle(Asset asset,
 boolean force)
             throws UserException,
ApplicationException

recycle asset with group versions if any
by group leader: recycle all group variants with its group versions too (see MC-4846)

Throws:

UserException

ApplicationException

recycledGetOriginalPath

public String recycledGetOriginalPath(Asset asset)

recycleRestore

public void recycleRestore(Asset asset)
                    throws ApplicationException,
UserException

restore asset with it versions if any
by group leader: restore all group variants with its group versions too (see MC-4846)

Throws:

ApplicationException

UserException

convert

public void convert(Asset asset)
             throws ApplicationException

Throws:

ApplicationException

convert

public void convert(List<Asset> assets)
             throws ApplicationException

Throws:

ApplicationException

startProcessingWorkflow

public void startProcessingWorkflow(Asset asset,
 List<AssetDerivateType> derivateTypesToCreate)
                             throws ApplicationException

called from outside by asset convert (user action)

Throws:

ApplicationException

changeType

public void changeType(List<Asset> assets,
 AssetType targetAssetType)
                throws ApplicationException

Changes type of assets.

Throws:

UserException - Always thrown with a message that asynchronous workflow has been started.

ApplicationException

changeTypeSync

public mc.core.system.workflow.ActionParameterList changeTypeSync(List<Asset> assets,
 AssetType targetAssetType)
                                                           throws ApplicationException

Changes type of assets.

Throws:

ApplicationException

copyToCollection

public Asset copyToCollection(Asset source,
 Collection targetCollection)
                       throws ApplicationException

Description copied from class: AbstractComplexEntityDO

create a copy of given source entity in parentCollection if given

Overrides:

copyToCollection in class AbstractComplexEntityDO<Asset>

Parameters:

source - mandatory

targetCollection - optional, default is parent collection of source

Returns:

copy

Throws:

ApplicationException

copy

public Asset copy(Asset source,
 Collection targetCollection)
           throws ApplicationException

Throws:

ApplicationException

See Also:

• AssetAPI#assetCopy(Asset, Collection)

copy

public Asset copy(Asset source,
 Collection targetCollection,
 AssetCopyFilter copyFilter)
           throws ApplicationException

Throws:

ApplicationException

See Also:

• AssetAPI#assetCopy(Asset, Collection, AssetCopyFilter)

copy

public List<Asset> copy(List<Asset> sourceAssets,
 Collection targetCollection)
                 throws ApplicationException

Throws:

ApplicationException

See Also:

• AssetAPI#assetCopy(List, Collection)

move

public Asset move(Asset source,
 Collection targetCollection)
           throws ApplicationException

Move asset, recoding the change in the change history.

Throws:

ApplicationException

move

public Asset move(Asset source,
 Collection targetCollection,
 boolean reportChange)
           throws ApplicationException

Parameters:

reportChange - true to record the move in the change history.

Throws:

ApplicationException

move

public void move(List<Asset> sourceAssets,
 Collection targetCollection)
          throws ApplicationException

Moves assets, alters primary collection.

Parameters:

sourceAssets - Assets to move from their primary collections.

targetCollection - New primary collection.

Throws:

UserException - Error message about skipped moves due to missing permissions or workflows preventing the move.

ApplicationException - Failure of move that was expected to succeed.

primaryCollectionChange

public void primaryCollectionChange(Asset asset,
 Collection newPrimaryCollection)
                             throws UserException,
ApplicationException

Sets newPrimaryCollection as primary collection. Sets old primary collection as secondary collection. Checks edit right and state on entity, delete right on collection.

Parameters:

entity - mandatory

newPrimaryCollection - mandatory

Throws:

UserException - Only informal, no need to rollback transaction.

ApplicationException - Transaction needs to be rolled back because entities might be in inconsistent state.

groupChangeRole

public void groupChangeRole(Asset asset,
 Asset.AssetGroupRole targetRole)
                     throws ApplicationException

Throws:

ApplicationException

groupRemove

public void groupRemove(Asset leader)
                 throws ApplicationException

Throws:

ApplicationException

groupGetAssets

public List<Asset> groupGetAssets(String assetGroupId,
 Asset.AssetGroupRole roleToSearch)

groupGetVersions

public List<Asset> groupGetVersions(Asset master)

groupGetMaster

public Asset groupGetMaster(Asset version)
                     throws ApplicationException

Throws:

ApplicationException

groupGetLeader

public Asset groupGetLeader(Asset variant)
                     throws ApplicationException

Throws:

ApplicationException

groupAddVariant

public void groupAddVariant(Asset variant,
 Asset leader)
                     throws ApplicationException

Throws:

ApplicationException

groupInsertVariant

public Asset groupInsertVariant(AssetInsertParameter param)
                         throws ApplicationException

Throws:

ApplicationException

groupInsertVersion

public Asset groupInsertVersion(AssetInsertParameter param,
 boolean makeActive)
                         throws ApplicationException

Throws:

ApplicationException

groupRemoveAsset

public void groupRemoveAsset(Asset asset)
                      throws ApplicationException

Throws:

ApplicationException

groupCreate

public void groupCreate(Asset master)
                 throws ApplicationException

Throws:

ApplicationException

getGroupAssets

public List<Asset> getGroupAssets(Asset master,
 String assetGroupId,
 Asset.AssetGroupRole roleToSearch,
 boolean onlyVisible)

replaceFile

public void replaceFile(Asset asset,
 InputStream fileStream,
 String filename)
                 throws ApplicationException

Throws:

ApplicationException

setDerivateFile

public void setDerivateFile(Asset asset,
 InputStream fileStream,
 String filename,
 ConverterType converterType)
                     throws ApplicationException

Throws:

ApplicationException

See Also:

• AssetAPI#assetSetDerivateFile(Asset, InputStream, String, ConverterType)

getRootCollection

public Collection getRootCollection()
                             throws ApplicationException

Throws:

ApplicationException

preview

public void preview(Asset asset,
 String format,
 String templateName,
 OutputStream os)
             throws ApplicationException

Throws:

ApplicationException

derivateDelete

public void derivateDelete(AssetDerivate derivate)
                    throws ApplicationException

Throws:

ApplicationException

derivateDelete

public void derivateDelete(List<AssetDerivate> derivates)
                    throws ApplicationException

Throws:

ApplicationException

sendEventOnExport

public void sendEventOnExport(Asset asset,
 AssetDerivate derivate,
 Basket basket)

validator

public mc.core.domain.asset.dobj.AssetDO.AssetValidator validator(Asset asset,
 DataMap map)
                                                           throws ApplicationException

Description copied from class: AbstractBaseDO

for persistent entity copy constructor be used, the copy of entity be mapped and validated
WARNING: in error case param map be changed! non valid fields be deleted from it
all error be collect as ValidationResults in ValidationException and throw only by validate() call
Examples to use:
1. validator( navigationHrc, dataMap).thatValidField( NavigationHrc.Field.navigationHrcType).validate(); 2. validator( navigation, dataMap).thatValidField( Navigation.Field.navigationType, Navigation.Field.navigationHrc) .thatNotNullIf( HrcEntity.Field.parent, n -> n.getNavigationType().getParentNavigationType() != null).validate(); 3. validator( entity, dataMap).thatValidField( Country.Field.iso2Code, "message.validate.Country.iso2Code.missing").thatUnique( Country.Field.iso2Code).validate();

Overrides:

validator in class AbstractBaseDO<Asset>

Parameters:

asset - mandatory

map - optional

Returns:

the validator

Throws:

ApplicationException - the application exception