Package mc.core.domain.base.dobj

Class AbstractComplexEntityDO<T extends ComplexEntity>

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<T>

All Implemented Interfaces:

IBaseDO<T>

Direct Known Subclasses:

AbstractAssetDO, AbstractHrcEntityDO, AbstractPrincipalDO, AttributeDO, ClassificationHrcDO, ComplexEntityDO, EntityProfileDO, ImportDO, ImportProfileDO, NavigationHrcDO, NodeHrcDO, ProjectDO, ProjectTaskDO, PublicationDO, PublicationProfileDO

public abstract class AbstractComplexEntityDO<T extends ComplexEntity>
extends AbstractEntityBaseDO<T>

Nested Class Summary

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

AbstractBaseDO.Initializer

Constructor Summary

Constructors

Constructor	Description
AbstractComplexEntityDO()

Method Summary

Modifier and Type	Method	Description
void	addDefaultSearchCriteria(List<mc.core.system.search.BaseSearchCriteria<?>> critList, String param)	add entity specific default search criteria to list for search by given param
void	assertPermission(ComplexEntity entity, RightType rightType)	assert permission for current session user and content locale.
void	assertPermission(Collection collection, RightType rightType, boolean forItem)	assert collection permission for current session user.
AspectAttribute<T>	attributes()
T	copy(T source)	Subclass of ComplexEntity passed to this method must implement a constructor that takes as sole argument an instance of this class, otherwise an ApplicationException is thrown.
Map<T,Set<Attribute>>	copyDataSync(ComplexEntity source, List<T> targetEntities, CopyFilter copyFilter)	copies data always directly, will not start a workflow.
T	copyToCollection(T source, Collection parentCollection)	create a copy of given source entity in parentCollection if given
void	delete(T entity, 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!
boolean	doRecursiveActionAsync(ComplexEntity entity)
T	edit(T entity)
void	entityProfileApply(List<T> entities, EntityProfile entityProfile, CopyFilter copyFilter)
void	entityProfileApply(T entity, EntityProfile entityProfile, CopyFilter copyFilter)
AspectFilter<T>	filter()
List<List<Collection>>	getCollectionHierarchies(ComplexEntity entity)
List<Collection>	getCollectionsAll(ComplexEntity entity)
T	getFromExternalKey(String externalKey)
mc.core.system.search.SearchFilter	getFromKeySearchFilter(String key)
User.UserBaseRole	getUserRole()	get at least needed user base role for the entity class
T	insert(T entity)
AspectLifecycle<T>	lifecycle()
ComplexEntityEvent<T>	newComplexEntityEvent(mc.core.service.event.Event.IEventType eventType, T entity)
void	onChange(ComplexEntity entity, String keyPostfix, Object... args)
AspectParameter<T>	parameter()
AspectPermission<T>	permissions()
mc.core.system.search.SearchFilter	prepareSearchFilter(mc.core.system.search.SearchFilter sf)	prepare searchFilter for (paged) SearchService search() methods.
AspectRelation<T>	relations()
void	secondaryCollectionAdd(ComplexEntity entity, Collection collection)	add given collection as secondary collection if not already present in collections (secondary and primary) of given entity.
void	secondaryCollectionCopy(List<T> entityList, Collection targetCollection)	add secondary collection link to given target collection for all entities of list for which user has EDIT right
void	secondaryCollectionMove(List<T> entityList, Collection sourceCollection, Collection targetCollection)	move secondary collection link from given source collection to target collection for all entities of lists for which user has EDIT right and state.
void	secondaryCollectionRemove(ComplexEntity entity, Collection collection)	removes given collection from secondary collections of given entity.
void	setRightInheritanceDisabled(ComplexEntity entity, boolean disable)
AspectState<T>	states()
T	translate(T entity, DataMap map, Locale locale)
AspectVersion<T>	versions()
AspectWatch<T>	watches()

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

getFromInternalDescription, save, sendEvent, sendEvent

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractComplexEntityDO

public AbstractComplexEntityDO()

Method Details

getUserRole

public User.UserBaseRole getUserRole()

Description copied from interface: IBaseDO

get at least needed user base role for the entity class

Specified by:

getUserRole in interface IBaseDO<T extends ComplexEntity>

Overrides:

getUserRole in class AbstractEntityBaseDO<T extends ComplexEntity>

permissions

public AspectPermission<T> permissions()

attributes

public AspectAttribute<T> attributes()

relations

public AspectRelation<T> relations()

states

public AspectState<T> states()

parameter

public AspectParameter<T> parameter()

filter

public AspectFilter<T> filter()

versions

public AspectVersion<T> versions()

watches

public AspectWatch<T> watches()

lifecycle

public AspectLifecycle<T> lifecycle()

assertPermission

public void assertPermission(ComplexEntity entity,
 RightType rightType)
                      throws UserException

assert permission for current session user and content locale. rightType optional, default is READ

Throws:

UserException

assertPermission

public void assertPermission(Collection collection,
 RightType rightType,
 boolean forItem)
                      throws UserException

assert collection permission for current session user. rightType optional, default is READ

Throws:

UserException

setRightInheritanceDisabled

public void setRightInheritanceDisabled(ComplexEntity entity,
 boolean disable)
                                 throws UserException

Throws:

UserException

getFromExternalKey

public T getFromExternalKey(String externalKey)
                     throws EntityNotFoundException,
NotUniqueResultException

Throws:

EntityNotFoundException

NotUniqueResultException

getFromKeySearchFilter

public mc.core.system.search.SearchFilter getFromKeySearchFilter(String key)

addDefaultSearchCriteria

public void addDefaultSearchCriteria(List<mc.core.system.search.BaseSearchCriteria<?>> critList,
 String param)

Description copied from interface: IBaseDO

add entity specific default search criteria to list for search by given param

Specified by:

addDefaultSearchCriteria in interface IBaseDO<T extends ComplexEntity>

Overrides:

addDefaultSearchCriteria in class AbstractEntityBaseDO<T extends ComplexEntity>

param - mandatory

prepareSearchFilter

public mc.core.system.search.SearchFilter prepareSearchFilter(mc.core.system.search.SearchFilter sf)

Description copied from class: AbstractBaseDO

prepare searchFilter for (paged) SearchService search() methods. override to add type specific criteria or ordering. always call super first when overriding and use returned filter

Overrides:

prepareSearchFilter in class AbstractEntityBaseDO<T extends ComplexEntity>

Returns:

prepared SearchFilter. never null

edit

public T edit(T entity)
       throws ApplicationException

Throws:

ApplicationException

translate

public T translate(T entity,
 DataMap map,
 Locale locale)
            throws ApplicationException

Throws:

ApplicationException

insert

public T insert(T entity)
         throws ApplicationException

Throws:

ApplicationException

delete

public void delete(T entity,
 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 AbstractBaseDO<T extends ComplexEntity>

Parameters:

entity - mandatory

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

Throws:

ApplicationException

copy

public T copy(T source)
       throws ApplicationException

Subclass of ComplexEntity passed to this method must implement a constructor that takes as sole argument an instance of this class, otherwise an ApplicationException is thrown. The copy constructor should set all properties that must be copied but not the dependent objects such as entityToAttributes.

Overrides:

copy in class AbstractEntityBaseDO<T extends ComplexEntity>

Parameters:

source - ComplexEntity, mandatory

Returns:

copy

Throws:

ApplicationException

copyToCollection

public T copyToCollection(T source,
 Collection parentCollection)
                   throws ApplicationException

create a copy of given source entity in parentCollection if given

Overrides:

copyToCollection in class AbstractEntityBaseDO<T extends ComplexEntity>

Parameters:

source - mandatory

parentCollection - optional, default is parent collection of source

Returns:

copy

Throws:

ApplicationException

entityProfileApply

public void entityProfileApply(T entity,
 EntityProfile entityProfile,
 CopyFilter copyFilter)
                        throws UserException,
ApplicationException

Throws:

UserException

ApplicationException

entityProfileApply

public void entityProfileApply(List<T> entities,
 EntityProfile entityProfile,
 CopyFilter copyFilter)
                        throws UserException,
ApplicationException

Throws:

UserException

ApplicationException

copyDataSync

public Map<T,Set<Attribute>> copyDataSync(ComplexEntity source,
 List<T> targetEntities,
 CopyFilter copyFilter)
                                   throws ApplicationException

copies data always directly, will not start a workflow. Caller must be mindful not to use this method for big lists or deep hierarchies. See #ceCopyData(ComplexEntity, List, CopyFilter, SessionData) for details

Parameters:

source - mandatory, the source entity

targetEntities - mandatory, list of target entities

copyFilter - CECopyFilter optional, use to differentiate which data should be copied. If null all data is copied.

Returns:

a map per target entity of the attributes that could not be copied because they are not configured by type of target entity

Throws:

ApplicationException

secondaryCollectionAdd

public void secondaryCollectionAdd(ComplexEntity entity,
 Collection collection)
                            throws ApplicationException

add given collection as secondary collection if not already present in collections (secondary and primary) of given entity. Checks edit right and state on entity, insert right on collection

Parameters:

entity - mandatory

collection - mandatory

Throws:

ApplicationException

secondaryCollectionRemove

public void secondaryCollectionRemove(ComplexEntity entity,
 Collection collection)
                               throws UserException,
ApplicationException

removes given collection from secondary collections of given entity. Checks edit right and state on entity, delete right on collection

Parameters:

entity - mandatory

collection - mandatory

Throws:

ApplicationException

UserException

secondaryCollectionCopy

public void secondaryCollectionCopy(List<T> entityList,
 Collection targetCollection)
                             throws ApplicationException

add secondary collection link to given target collection for all entities of list for which user has EDIT right

Throws:

ApplicationException

secondaryCollectionMove

public void secondaryCollectionMove(List<T> entityList,
 Collection sourceCollection,
 Collection targetCollection)
                             throws ApplicationException

move secondary collection link from given source collection to target collection for all entities of lists for which user has EDIT right and state.

Throws:

ApplicationException

getCollectionHierarchies

public List<List<Collection>> getCollectionHierarchies(ComplexEntity entity)

Parameters:

entity - must be ICollectionManaged or ICollectionListManaged

Returns:

a list that has for each assigned collection of entity (primary or secondary) the collection hierarchy as list, each list starting with the root collection and having the assigned collection as last member.

getCollectionsAll

public List<Collection> getCollectionsAll(ComplexEntity entity)

Parameters:

entity - mandatory

Returns:

flattened list with no duplicates of getCollectionHierarchies(ComplexEntity)

onChange

public void onChange(ComplexEntity entity,
 String keyPostfix,
 Object... args)

See Also:

• VersionManager.onChange(ComplexEntity, String, Object...)

doRecursiveActionAsync

public boolean doRecursiveActionAsync(ComplexEntity entity)

newComplexEntityEvent

public ComplexEntityEvent<T> newComplexEntityEvent(mc.core.service.event.Event.IEventType eventType,
 T entity)