Package de.digitalcollections.cudami.server.business.api.service.identifiable

Interface NodeService<N extends de.digitalcollections.model.identifiable.Identifiable>

All Superinterfaces:

IdentifiableService<N>

All Known Subinterfaces:

CollectionService, TopicService, WebpageService

All Known Implementing Classes:

CollectionServiceImpl, TopicServiceImpl, WebpageServiceImpl

public interface NodeService<N extends de.digitalcollections.model.identifiable.Identifiable>
extends IdentifiableService<N>

Method Summary

Modifier and Type	Method	Description
default boolean	addChild(UUID parentUuid, UUID childUuid)
default boolean	addChild(N parent, N child)
boolean	addChildren(UUID parentUuid, List<UUID> childrenUUIDs)
default boolean	addChildren(N parent, List<N> children)
de.digitalcollections.model.list.paging.PageResponse<N>	findChildren(UUID uuid, de.digitalcollections.model.list.paging.PageRequest pageRequest)
de.digitalcollections.model.list.paging.PageResponse<N>	findRootNodes(de.digitalcollections.model.list.paging.PageRequest pageRequest)
de.digitalcollections.model.view.BreadcrumbNavigation	getBreadcrumbNavigation(UUID nodeUuid)	Build and return the breadcrumb navigation for the given node UUID
default de.digitalcollections.model.view.BreadcrumbNavigation	getBreadcrumbNavigation(UUID nodeUuid, Locale locale, Locale fallbackLocale)	Build and return the breadcrumb navigation for the given webpage UUID and desired locale.
List<N>	getChildren(UUID nodeUuid)
default List<N>	getChildren(N node)
N	getParent(UUID nodeUuid)
default N	getParent(N node)
List<N>	getParents(UUID uuid)
List<Locale>	getRootNodesLanguages()
boolean	removeChild(UUID parentUuid, UUID childUuid)
default boolean	removeChild(N parent, N child)
N	saveWithParent(UUID childUuid, UUID parentUuid)
default N	saveWithParent(N child, UUID parentUuid)
boolean	updateChildrenOrder(UUID parentUuid, List<N> children)

Methods inherited from interface de.digitalcollections.cudami.server.business.api.service.identifiable.IdentifiableService

addRelatedEntity, addRelatedEntity, addRelatedFileresource, addRelatedFileresource, cleanupLabelFromUnwantedLocales, count, delete, delete, find, find, findByLanguageAndInitial, getAllFull, getAllReduced, getByIdentifier, getByIdentifier, getByUuid, getByUuidAndLocale, getLanguages, getRelatedEntities, getRelatedEntities, getRelatedFileResources, getRelatedFileResources, save, saveRelatedEntities, setRelatedEntities, setRelatedFileResources, setRelatedFileResources, update

Method Detail

addChild

default boolean addChild(N parent,
                         N child)

addChild

default boolean addChild(UUID parentUuid,
                         UUID childUuid)

addChildren

default boolean addChildren(N parent,
                            List<N> children)

addChildren

boolean addChildren(UUID parentUuid,
                    List<UUID> childrenUUIDs)

getBreadcrumbNavigation

de.digitalcollections.model.view.BreadcrumbNavigation getBreadcrumbNavigation(UUID nodeUuid)

Build and return the breadcrumb navigation for the given node UUID

Parameters:

nodeUuid - the uuid of the node.

Returns:

BreadcrumbNavigation with labels in all available languages

getBreadcrumbNavigation

default de.digitalcollections.model.view.BreadcrumbNavigation getBreadcrumbNavigation(UUID nodeUuid,
                                                                                      Locale locale,
                                                                                      Locale fallbackLocale)

Build and return the breadcrumb navigation for the given webpage UUID and desired locale. If no label for that locale exists, use the label for the fallbackLocale, and if even this fails, use the first locale.

Parameters:

nodeUuid - the uuid of the webpage

locale - the desired locale for the navigation item labels

fallbackLocale - the fallback locale for the navigation item labels

Returns:

Breadcrumb navigation with labels in the desired language (if possible)

getChildren

default List<N> getChildren(N node)

getChildren

List<N> getChildren(UUID nodeUuid)

findChildren

de.digitalcollections.model.list.paging.PageResponse<N> findChildren(UUID uuid,
                                                                     de.digitalcollections.model.list.paging.PageRequest pageRequest)

getParent

default N getParent(N node)

getParent

N getParent(UUID nodeUuid)

getParents

List<N> getParents(UUID uuid)

findRootNodes

de.digitalcollections.model.list.paging.PageResponse<N> findRootNodes(de.digitalcollections.model.list.paging.PageRequest pageRequest)

getRootNodesLanguages

List<Locale> getRootNodesLanguages()

removeChild

default boolean removeChild(N parent,
                            N child)

removeChild

boolean removeChild(UUID parentUuid,
                    UUID childUuid)

saveWithParent

default N saveWithParent(N child,
                         UUID parentUuid)
                  throws IdentifiableServiceException,
                         ValidationException

Parameters:

child - newly created child node to be saved

parentUuid - parent node the new node is child of

Returns:

saved child node

Throws:

IdentifiableServiceException - if saving fails

ValidationException

saveWithParent

N saveWithParent(UUID childUuid,
                 UUID parentUuid)
          throws IdentifiableServiceException

Parameters:

childUuid - UUID of newly created child node

parentUuid - parent node the new node is child of

Returns:

saved child node

Throws:

IdentifiableServiceException - if saving fails

updateChildrenOrder

boolean updateChildrenOrder(UUID parentUuid,
                            List<N> children)