Package mc.core.domain.channel.dobj

Class NavigationDO

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>

mc.core.domain.base.dobj.AbstractHrcEntityDO<Navigation>

mc.core.domain.channel.dobj.NavigationDO

All Implemented Interfaces:

IBaseDO<Navigation>

public class NavigationDO
extends AbstractHrcEntityDO<Navigation>

Nested Class Summary

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

AbstractBaseDO.Initializer

Constructor Summary

Constructors

Constructor	Description
NavigationDO()

Method Summary

Modifier and Type	Method	Description
void	addClassification(Navigation navigation, Classification classification)
NavigationToNode	addNode(Navigation navigation, Node node, int prio)
void	assertPermission(ComplexEntity entity, RightType rightType)	assert permission for current session user and content locale.
void	changeOrderOfNode(Navigation navigation, Node node, boolean decreaseOrder)
Navigation	copy(Navigation source, Navigation parent)	Creates a deep copy of given HrcEntity, i.e.
Navigation	copy(Navigation source, Navigation parent, NavigationHrc navHrc)
User.UserBaseRole	getUserRole()	get at least needed user base role for the entity class
Navigation	insert(Navigation navigation)
void	move(Navigation toMove, Navigation target)
void	removeClassification(Navigation navigation)
void	removeNode(Navigation navigation, Node node)
Navigation	save(Navigation navigation, DataMap dataMap)	map data to entity if any, validate and save
void	setNodes(NavigationToNode navToNode, List<Node> desiredNodes)	Creates or removes RangeItems to match the given Nodes.

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

getAllOffspring

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

addDefaultSearchCriteria, assertPermission, attributes, copy, copyDataSync, copyToCollection, delete, doRecursiveActionAsync, edit, entityProfileApply, entityProfileApply, filter, getCollectionHierarchies, getCollectionsAll, getFromExternalKey, getFromKeySearchFilter, 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, validator

Methods inherited from class java.lang.Object

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

Constructor Details

NavigationDO

public NavigationDO()

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

Overrides:

getUserRole in class AbstractComplexEntityDO<Navigation>

assertPermission

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

Description copied from class: AbstractComplexEntityDO

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

Overrides:

assertPermission in class AbstractComplexEntityDO<Navigation>

Throws:

UserException

insert

public Navigation insert(Navigation navigation)
                  throws ApplicationException

Overrides:

insert in class AbstractComplexEntityDO<Navigation>

Throws:

ApplicationException

save

public Navigation save(Navigation navigation,
 DataMap dataMap)
                throws ApplicationException

Description copied from interface: IBaseDO

map data to entity if any, validate and save

Specified by:

save in interface IBaseDO<Navigation>

Overrides:

save in class AbstractEntityBaseDO<Navigation>

Parameters:

navigation - mandatory

dataMap - optional

Returns:

mapped entity

Throws:

ApplicationException

addNode

public NavigationToNode addNode(Navigation navigation,
 Node node,
 int prio)
                         throws ApplicationException

Throws:

ApplicationException

removeNode

public void removeNode(Navigation navigation,
 Node node)
                throws ApplicationException

Throws:

ApplicationException

changeOrderOfNode

public void changeOrderOfNode(Navigation navigation,
 Node node,
 boolean decreaseOrder)
                       throws ApplicationException

Throws:

ApplicationException

setNodes

public void setNodes(NavigationToNode navToNode,
 List<Node> desiredNodes)
              throws ApplicationException

Creates or removes RangeItems to match the given Nodes.

Parameters:

navToNode - Parent of RangeItems. Must not be null.

desiredNodes - optional
Nodes for which RangeItems will exist after execution of this method.
Existent RangeItems which are not in this list are seen as obsolete and discarded. if desiredNodes == null --> add all children recursively (getAllOffspring( navToNode.getNode())))
if desiredNodes is empty -> remove all assigned range items
else filter desiredNodes by getAllOffspring( navToNode.getNode()), only children node be added.

Throws:

ApplicationException

addClassification

public void addClassification(Navigation navigation,
 Classification classification)
                       throws ApplicationException

Throws:

ApplicationException

removeClassification

public void removeClassification(Navigation navigation)
                          throws ApplicationException

Throws:

ApplicationException

move

public void move(Navigation toMove,
 Navigation target)
          throws UserException,
ApplicationException

Throws:

UserException

ApplicationException

copy

public Navigation copy(Navigation source,
 Navigation parent)
                throws ApplicationException

Description copied from class: AbstractHrcEntityDO

Creates a deep copy of given HrcEntity, i.e. copies also all offspring. For large hierarchical trees this can take substantial time. Subclass of HrcEntity 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 AbstractHrcEntityDO<Navigation>

Parameters:

source - HrcEntity, mandatory

parent - HrcEntity, mandatory if hierarchy level of source demands a parent. Gives the parent to which copied object should belong. parentForCopy must be of same type as parent of source if the levels of the hierarchy are differentiated by type.

Returns:

copy

Throws:

ApplicationException

copy

public Navigation copy(Navigation source,
 Navigation parent,
 NavigationHrc navHrc)
                throws ApplicationException

Throws:

ApplicationException