com.communote.server.core.user

Interface NavigationItemManagement

All Known Implementing Classes:

NavigationItemManagementImpl

public interface NavigationItemManagement

Author:

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

Method Summary

Modifier and Type	Method and Description
boolean	createBuiltInNavigationItems(Long userId) Create the built-in immutable navigation items for the current user if they do not yet exist.
boolean	delete(Long navigationItemId) Delete a given item.
<DATA_TYPE extends NavigationItemDataTO> List<NavigationItemTO<DATA_TYPE>>	find(Class<DATA_TYPE> type, Long... navigationItemIds) Method to find all items for the current user.
<T> Collection<T>	get(CollectionConverter<NavigationItem,T> converter, Long... ids) Method to find all navigation items for the current user.
<DATA_TYPE extends NavigationItemDataTO> NavigationItemTO<DATA_TYPE>	get(Long notificationItemId, Class<DATA_TYPE> type) Method to get an item for the given user.
<T extends NavigationItemDataTO> Long	store(NavigationItemTO<T> navigationItem) Updates the given item or creates a new one.

Method Detail

createBuiltInNavigationItems

boolean createBuiltInNavigationItems(Long userId)
                              throws AuthorizationException

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

Parameters:

userId - The ID of the user to update

Returns:

true if the items where created, false if they already existed

Throws:

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

delete

boolean delete(Long navigationItemId)
        throws AuthorizationException

Delete a given item.

Parameters:

navigationItemId - ID of the item to delete.

Returns:

whether the item existed

Throws:

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

find

<DATA_TYPE extends NavigationItemDataTO> List<NavigationItemTO<DATA_TYPE>> find(Class<DATA_TYPE> type,
                                                                                Long... navigationItemIds)
                                                                         throws NavigationItemDataSerializationException

Method to find all items for the current user.

Type Parameters:

DATA_TYPE - the type of the data of the item

Parameters:

type - the type of the data of the item

navigationItemIds - Id's of items to load or null, if all.

Returns:

List of loaded navigation items.

Throws:

NavigationItemDataSerializationException - Thrown, when the given data can't be converted into the given type.

get

<T> Collection<T> get(CollectionConverter<NavigationItem,T> converter,
                      Long... ids)

Method to find all navigation items for the current user.

Type Parameters:

T - Type of the result.

Parameters:

converter - The converter to use for result converting.

ids - Ids of items to get or null to get all items.

Returns:

List of results. This never returns null.

get

<DATA_TYPE extends NavigationItemDataTO> NavigationItemTO<DATA_TYPE> get(Long notificationItemId,
                                                                         Class<DATA_TYPE> type)
                                                                  throws NavigationItemDataSerializationException

Method to get an item for the given user.

Type Parameters:

DATA_TYPE - the type of the data of the item

Parameters:

notificationItemId - Id of the item to get.

type - Type of the data, if null, the data won't be deserialized.

Returns:

Null, if the item doesn't exists for the given user (this exits quietly).

Throws:

NavigationItemDataSerializationException - Thrown, when the given data can't be converted into the given type.

store

<T extends NavigationItemDataTO> Long store(NavigationItemTO<T> navigationItem)
                                     throws AuthorizationException,
                                            NavigationItemDataSerializationException

Updates the given item or creates a new one.

Type Parameters:

T - the type of the data of the item

Parameters:

navigationItem - Item to update.

Returns:

Id of the created or updated item.

Throws:

AuthorizationException - in case the item to update exists but the current user is not the owner of it

NavigationItemDataSerializationException - Thrown, when the given data can't be converted into JSON