com.sdl.dxa.tridion.navigation.dynamic.NavigationModelProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dxa-common Show documentation

DXA Common project contains framework common classes shared between all other artifacts

There is a newer version: 2.3.7

package com.sdl.dxa.tridion.navigation.dynamic;

import com.sdl.dxa.api.datamodel.model.TaxonomyNodeModelData;
import com.sdl.dxa.common.dto.SitemapRequestDto;
import org.jetbrains.annotations.NotNull;

import java.util.Optional;

/**
 * Navigation provider provides access to the navigation model of the publication.
 * Data model from {@code dxa-data-model} aka {@code R2} is used.
 *
 * @since 2.0
 */
@FunctionalInterface
public interface NavigationModelProvider {

    /**
     * Loads full navigation model based on a request. Returns an optional in case model is not available but the request is valid.
     *
     * @param requestDto current request with mandatory localization ID
     * @return optional with root navigation model
     */
    Optional getNavigationModel(@NotNull SitemapRequestDto requestDto);
}