com.logicaldoc.core.security.dao

Interface MenuDAO

All Superinterfaces:

PersistentObjectDAO<Menu>

All Known Implementing Classes:

HibernateMenuDAO

public interface MenuDAO
extends PersistentObjectDAO<Menu>

Instances of this class is a DAO-service for menu objects.

Version:

1.0

Author:

Michael Scholz

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applyRithtToTree(long id) Propagates the security policies of a node to the whole subree
String	computePathExtended(long id) Dynamically computes the path extended for the specified menu.
void	deleteAll(List<Menu> menus) For each menu, save the folder delete history entry for each folder and delete the folder
List<Menu>	findByGroupId(long groupId) Finds all menus accessible by the passed group
List<Menu>	findByParentId(long parentId) Finds all children(direct and indirect) by parentId
List<Menu>	findByText(Menu parent, String text, boolean caseSensitive) Finds all menus by menu text, contained in the parent menu
List<Menu>	findByText(String text) Finds all menus by menu text.
List<Menu>	findByTextAndParentId(String text, long parentId) Finds that folder that lies under a specific parent (given by the id) an with a given text(like operator is used)
List<Menu>	findByUserId(long userId) Finds authorized menus for a user.
List<Menu>	findByUserId(long userId, long parentId) Finds direct children of a menu.
List<Menu>	findChildren(long parentId, Integer max) Finds direct children of a menu.
List<Menu>	findChildren(long parentId, long userId) Finds direct children of a menu accessible by the given user.
List<Long>	findIdByUserId(long userId, long parentId) This method selects only the menuId from the menus for which a user is authorized.
List<Long>	findMenuIdByUserId(long userId) This method selects only the menuId from the menus for which a user is authorized.
List<Long>	findMenuIdByUserIdAndPermission(long userId, Permission permission) Finds all menus ids with a specific permission enabled on the specifies user
List<Menu>	findParents(long id) Returns a List of menus being a parent of the given menu.
String	findTextById(long id) This method selects only the menu text from a menu.
boolean	hasWriteAccess(Menu menu, long userId) Checks that the user has access to the menu and all its sub-items
int	isMenuWriteable(long id, long userId) Returns if a menu is writeable for a user
boolean	isReadEnable(long id, long userId)
boolean	isWriteEnable(long id, long userId) This method is looking up for writing rights for a menu and an user.
void	restore(long id, boolean parents) Restores a previously deleted menu
boolean	store(Menu menu) Same as store(Menu, boolean)

Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

bulkUpdate, delete, deleteAll, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDbms, initialize, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet

Method Detail

findByText

List<Menu> findByText(String text)

Finds all menus by menu text.

Parameters:

text -

Returns:

List of menus with given menu text.

findByText

List<Menu> findByText(Menu parent,
                    String text,
                    boolean caseSensitive)

Finds all menus by menu text, contained in the parent menu

Parameters:

parent - The parent menu(optional)

text - The menutext to search for

caseSensitive -

Returns:

List of menus with given menu text.

findByUserId

List<Menu> findByUserId(long userId)

Finds authorized menus for a user.

Parameters:

userId - ID of the user.

Returns:

List of found menus.

findMenuIdByUserIdAndPermission

List<Long> findMenuIdByUserIdAndPermission(long userId,
                                         Permission permission)

Finds all menus ids with a specific permission enabled on the specifies user

Parameters:

userId - The user identifier

permission - The permission to check

Returns:

findByUserId

List<Menu> findByUserId(long userId,
                      long parentId)

Finds direct children of a menu.

Parameters:

parentId - MenuId of the menu which children are wanted.

Returns:

List of found menus sorted by text

findByParentId

List<Menu> findByParentId(long parentId)

Finds all children(direct and indirect) by parentId

Parameters:

parentId -

Returns:

findChildren

List<Menu> findChildren(long parentId,
                      Integer max)

Finds direct children of a menu.

Parameters:

parentId - MenuId of the menu which children are wanted

max - Optional, maximum number of children

Returns:

List of found menus

findChildren

List<Menu> findChildren(long parentId,
                      long userId)

Finds direct children of a menu accessible by the given user.

Parameters:

parentId - MenuId of the menu which children are wanted

userId - Identifier of the user that mush have read access

Returns:

List of found menus.

isWriteEnable

boolean isWriteEnable(long id,
                    long userId)

This method is looking up for writing rights for a menu and an user.

Parameters:

id - ID of the menu.

userId - ID of the user.

isReadEnable

boolean isReadEnable(long id,
                   long userId)

findTextById

String findTextById(long id)

This method selects only the menu text from a menu.

Parameters:

id - Id of the menu.

Returns:

Selected menu text.

findMenuIdByUserId

List<Long> findMenuIdByUserId(long userId)

This method selects only the menuId from the menus for which a user is authorized.

Parameters:

userId - ID of the user.

Returns:

List of selected menuId's.

findIdByUserId

List<Long> findIdByUserId(long userId,
                        long parentId)

This method selects only the menuId from the menus for which a user is authorized. Only menus direct child of the specified parent are returned.

Parameters:

userId - ID of the user.

parentId - Parent menu

Returns:

List of selected menuId's.

isMenuWriteable

int isMenuWriteable(long id,
                  long userId)

Returns if a menu is writeable for a user

Parameters:

id - check this menu

userId - privileges for this should be checked

Returns:

a 0 if false, a 1 if true

hasWriteAccess

boolean hasWriteAccess(Menu menu,
                     long userId)

Checks that the user has access to the menu and all its sub-items

findByGroupId

List<Menu> findByGroupId(long groupId)

Finds all menus accessible by the passed group

Parameters:

groupId - The group id

Returns:

The List of menus

findParents

List<Menu> findParents(long id)

Returns a List of menus being a parent of the given menu. The list is ordered starting from the root of menus.

Parameters:

id -

restore

void restore(long id,
           boolean parents)

Restores a previously deleted menu

Parameters:

id - The menu identifier

parents - true if parents must be restored also

findByTextAndParentId

List<Menu> findByTextAndParentId(String text,
                               long parentId)

Finds that folder that lies under a specific parent (given by the id) an with a given text(like operator is used)

Parameters:

text -

parentId -

Returns:

store

boolean store(Menu menu)

Same as store(Menu, boolean)

Specified by:

store in interface PersistentObjectDAO<Menu>

Parameters:

menu - entity to be stored.

Returns:

True if successfully stored in a database.

deleteAll

void deleteAll(List<Menu> menus)

For each menu, save the folder delete history entry for each folder and delete the folder

Parameters:

menu - List of menu to be delete

computePathExtended

String computePathExtended(long id)

Dynamically computes the path extended for the specified menu. The path extended is a human readable path in the form: /folder1/folder2/folder3

Parameters:

id -

Returns:

applyRithtToTree

boolean applyRithtToTree(long id)

Propagates the security policies of a node to the whole subree