org.opennms.web.navigate.MenuEntry Maven / Gradle / Ivy

Go to download
/*
 * Licensed to The OpenNMS Group, Inc (TOG) under one or more
 * contributor license agreements.  See the LICENSE.md file
 * distributed with this work for additional information
 * regarding copyright ownership.
 *
 * TOG licenses this file to You under the GNU Affero General
 * Public License Version 3 (the "License") or (at your option)
 * any later version.  You may not use this file except in
 * compliance with the License.  You may obtain a copy of the
 * License at:
 *
 *      https://www.gnu.org/licenses/agpl-3.0.txt
 *
 * 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 org.opennms.web.navigate;

import java.util.List;

/**
 * Simple representation of an entry in the menu.
 * @author mvrueden
 */
public interface MenuEntry {
    String getName();

    String getUrl();

    DisplayStatus getDisplayStatus();

    /**
     * If the list is null or empty, the {@link MenuEntry} is a leaf element and actually clickable.
     *
     * @return The number of sub elements if this {@link MenuEntry} is a parent element. Otherwise an empty list or null.
     */
    List getEntries();
}