001/*
002 *  Copyright 2018 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.web.frontoffice.search.instance.model;
017
018/**
019 * A sitemap context type
020 */
021public enum SitemapContextType
022{
023    /**
024     * The sitemap of the context is the whole sitemap of the current site.
025     */
026    CURRENT_SITE,
027    /**
028     * The sitemap of the context is all child pages of the current page.
029     */
030    CHILD_PAGES,
031    /**
032     * The sitemap of the context is all child pages of the pages returned by {@link SitemapContext#getPages()}.
033     */
034    CHILD_PAGES_OF,
035    /**
036     * The sitemap of the context is direct child pages of the current page.
037     */
038    DIRECT_CHILD_PAGES,
039    /**
040     * The sitemap of the context is direct child pages of the pages returned by {@link SitemapContext#getPages()}.
041     */
042    DIRECT_CHILD_PAGES_OF
043}