001/*
002 *  Copyright 2023 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.runtime.plugins.admin.statistics;
017
018import java.util.Map;
019
020import org.ametys.runtime.i18n.I18nizableText;
021
022/**
023 * Statistics parent interface 
024 */
025public interface Statistics
026{
027    /**
028     * The node identifier
029     * @return an identifier
030     */
031    public String getName();
032    
033    /**
034     * The node label
035     * @return label
036     */
037    public I18nizableText getLabel();
038    
039    /**
040     * The icon
041     * @return The glyph icon
042     */
043    public String getIcon();
044    
045    /**
046     * Get the json for the statistics export
047     * @return A non null json
048     */
049    public Map<String, Object> toJSONForExport();
050
051    /**
052     * Get the json for the client tree
053     * @return A non null json for tree
054     */
055    public Map<String, Object> toJSONTree();
056}