Package org.cyclos.impl.contentmanagement

Class MenuEntryServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<E,A,DTO,D,DP>

org.cyclos.impl.contentmanagement.BaseContentItemServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

org.cyclos.impl.contentmanagement.MenuEntryServiceImpl

All Implemented Interfaces:

MenuEntryServiceLocal, CRUDServiceLocal<MenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>, MenuEntryService, CRUDService<MenuEntryDTO,MenuEntryData,MenuEntryDataParams>, CRUDWithConfirmationPasswordService<MenuEntryDTO,MenuEntryData,MenuEntryDataParams>, Service

@Service
public class MenuEntryServiceImpl
extends BaseContentItemServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>
implements MenuEntryServiceLocal

Implementation for MenuEntryService

Field Summary

Fields inherited from class org.cyclos.impl.contentmanagement.BaseContentItemServiceImpl

configurationPath, configurationService

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
MenuEntryServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected MenuEntryData	getData(MenuEntry contentItem)	Returns details data for the given entity
MenuEntriesListData	getListData(ConfigurationVO configurationVO)	Returns data with the list of menus for the given configuration
List<MenuEntryVO>	getMenu(Frontend frontend)	Returns the menu entries for the logged user.
MenuItemDetailedVO	getMenuItemDetails(MenuItemVO vo)	Returns details for the given menu item
List<MenuEntryVO>	list(ConfigurationVO configurationVO)	Lists menu entries in the given configuration
List<MenuEntry>	list(Frontend frontend, Configuration configuration, boolean rootOnly, Collection<ContentItemVisibility> visibilities, boolean includeFloatingPages)	Lists the pages applicable to the given frontend and visibility
List<MenuItem>	listByWizard(MenuItemWizard wizard)	Returns the menu items that show the given wizard, if any
List<SitemapItemVO>	listForSitemap()	Returns the sitemap entries for all enabled menu items of type content and floating pages in this network
void	move(Long id, boolean up)	Moves the given entry in order, either up or down
MenuEntry	newEntity(MenuEntryDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(MenuEntry entity)	May be overridden in order to perform custom logic after removing an entity
protected void	onAfterSave(MenuEntry entity, MenuEntry currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(MenuEntry entry, MenuEntry currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(MenuEntryDTO dto)
protected org.apache.commons.collections4.BidiMap<Class<? extends MenuEntry>,Class<? extends MenuEntryDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.

Methods inherited from class org.cyclos.impl.contentmanagement.BaseContentItemServiceImpl

toDTO

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Constructor Detail

MenuEntryServiceImpl

public MenuEntryServiceImpl()

Method Detail

getListData

public MenuEntriesListData getListData(ConfigurationVO configurationVO)
                                throws FrameworkException

Description copied from interface: MenuEntryService

Returns data with the list of menus for the given configuration

Specified by:

getListData in interface MenuEntryService

Throws:

FrameworkException

getMenu

public List<MenuEntryVO> getMenu(Frontend frontend)

Description copied from interface: MenuEntryServiceLocal

Returns the menu entries for the logged user. Not the same as converting the list of MenuEntry to MenuEntryVO, but each element is converted to it's corresponding vo, like MenuGroupVO and MenuItemVO, and only visible entries are returned.

Specified by:

getMenu in interface MenuEntryServiceLocal

getMenuItemDetails

public MenuItemDetailedVO getMenuItemDetails(MenuItemVO vo)
                                      throws FrameworkException

Description copied from interface: MenuEntryService

Returns details for the given menu item

Specified by:

getMenuItemDetails in interface MenuEntryService

Throws:

FrameworkException

list

public List<MenuEntryVO> list(ConfigurationVO configurationVO)
                       throws FrameworkException

Description copied from interface: MenuEntryService

Lists menu entries in the given configuration

Specified by:

list in interface MenuEntryService

Throws:

FrameworkException

list

public List<MenuEntry> list(Frontend frontend,
                            Configuration configuration,
                            boolean rootOnly,
                            Collection<ContentItemVisibility> visibilities,
                            boolean includeFloatingPages)

Description copied from interface: MenuEntryServiceLocal

Lists the pages applicable to the given frontend and visibility

Specified by:

list in interface MenuEntryServiceLocal

listByWizard

public List<MenuItem> listByWizard(MenuItemWizard wizard)

Description copied from interface: MenuEntryServiceLocal

Returns the menu items that show the given wizard, if any

Specified by:

listByWizard in interface MenuEntryServiceLocal

listForSitemap

public List<SitemapItemVO> listForSitemap()

Description copied from interface: MenuEntryServiceLocal

Returns the sitemap entries for all enabled menu items of type content and floating pages in this network

Specified by:

listForSitemap in interface MenuEntryServiceLocal

move

public void move(Long id,
                 boolean up)
          throws EntityNotFoundException

Description copied from interface: MenuEntryService

Moves the given entry in order, either up or down

Specified by:

move in interface MenuEntryService

Throws:

EntityNotFoundException

newEntity

public MenuEntry newEntity(MenuEntryDataParams params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<MenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

Specified by:

newEntity in class CRUDServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

getData

protected MenuEntryData getData(MenuEntry contentItem)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

onAfterRemove

protected void onAfterRemove(MenuEntry entity)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after removing an entity

Overrides:

onAfterRemove in class CRUDServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

onAfterSave

protected void onAfterSave(MenuEntry entity,
                           MenuEntry currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

onBeforeSave

protected Object onBeforeSave(MenuEntry entry,
                              MenuEntry currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(MenuEntryDTO dto)

Overrides:

resolveValidator in class BaseContentItemServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends MenuEntry>,Class<? extends MenuEntryDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<MenuEntry,QMenuEntry,MenuEntryDTO,MenuEntryData,MenuEntryDataParams>