com.communote.server.service

Class NavigationItemService

java.lang.Object

com.communote.server.service.NavigationItemService

@Service
public class NavigationItemService
extends Object

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
NavigationItemService()

Method Summary

Modifier and Type	Method and Description
void	createBuiltInNavigationItems(Long userId) Create the built-in navigation items for the provided user if they do not yet exist.
void	delete(Long navigationItemId) Deletes the given item.
List<NavigationItemTO<NavigationItemDataTO>>	find(Long... navigationItemIds) Get the matching navigation items of the current user.
NavigationItemTO<NavigationItemDataTO>	get(Long navigationItemId) Get a specific navigation item.
Long	store(String name, Integer index, Date lastAccessDate, NavigationItemDataTO data) Create a navigation item for the current user.
Long	update(Long navigationItemId, String name, Integer index, Date lastAccessDate, NavigationItemDataTO data) Update a navigation item of the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationItemService

public NavigationItemService()

Method Detail

createBuiltInNavigationItems

public void createBuiltInNavigationItems(Long userId)
                                  throws AuthorizationException

Create the built-in navigation items for the provided user if they do not yet exist.

Parameters:

userId - The ID of the user for whom the items should be created, if omitted the current user will be taken

Throws:

AuthorizationException - If the current user is not the provided user or the internal system user

delete

public void delete(Long navigationItemId)
            throws AuthorizationException

Deletes the given item.

Parameters:

navigationItemId - Item to delete.

Throws:

AuthorizationException - in case the current user is not the owner of the item

find

public List<NavigationItemTO<NavigationItemDataTO>> find(Long... navigationItemIds)

Get the matching navigation items of the current user.

Parameters:

navigationItemIds - IDs of the items to load. Provide no ID to get all

Returns:

List of loaded navigation items.

get

public NavigationItemTO<NavigationItemDataTO> get(Long navigationItemId)

Get a specific navigation item.

Parameters:

navigationItemId - ID of the item to get

Returns:

The item or null if it does not exist or is not owned by the current user.

store

public Long store(String name,
                  Integer index,
                  Date lastAccessDate,
                  NavigationItemDataTO data)
           throws NavigationItemDataSerializationException

Create a navigation item for the current user.

Parameters:

name - The name to set.

index - Index of the item. If null the index will be 0.

lastAccessDate - The last access date. If null the current date will be used.

data - The data.

Returns:

Id of the stored item.

Throws:

NavigationItemDataSerializationException - in case the data can not be converted into a string

update

public Long update(Long navigationItemId,
                   String name,
                   Integer index,
                   Date lastAccessDate,
                   NavigationItemDataTO data)
            throws NotFoundException,
                   NavigationItemDataSerializationException

Update a navigation item of the current user.

Parameters:

navigationItemId - Id of the item to update.

name - The name to set. If null the current name will be used.

index - Index of the item. If null, this will not be updated.

lastAccessDate - The last access date. If null, this will not be updated.

data - The data. If null, this will not be updated.

Returns:

Id of the stored item.

Throws:

NotFoundException - in case the item to update does not exist or does not belong to the current user

NavigationItemDataSerializationException - in case the data can not be converted into a string