SitemapNode.java

/*
 *
 *  * Copyright (c) 2016. David Sowerby
 *  *
 *  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 *  * the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 *  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 *  * specific language governing permissions and limitations under the License.
 *
 */
package uk.q3c.krail.core.navigate.sitemap;

import uk.q3c.krail.core.i18n.I18NKey;
import uk.q3c.krail.core.shiro.PageAccessControl;
import uk.q3c.krail.core.view.KrailView;

import java.io.Serializable;
import java.util.List;

public interface SitemapNode extends Serializable {

    String getUriSegment();

    I18NKey getLabelKey();

    Class<? extends KrailView> getViewClass();

    PageAccessControl getPageAccessControl();

    List<String> getRoles();

    int getId();

    /**
     * Returns the index of the position a node should be compared to its siblings
     * @return The index of the position a node should be compared to its siblings
     */
    int getPositionIndex();
}