001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.ui.apps; 029 030import java.util.Locale; 031 032/** 033 * App category interface.<p> 034 */ 035public interface I_CmsAppCategory extends I_CmsHasOrder { 036 037 /** 038 * Returns the id.<p> 039 * 040 * @return the id 041 */ 042 String getId(); 043 044 /** 045 * Gets the user readable name for the category for a given locale.<p> 046 * 047 * @param locale the locale for which to get the name 048 * 049 * @return the localized name 050 */ 051 String getName(Locale locale); 052 053 /** 054 * Returns the parentId.<p> 055 * 056 * App categories can be nested. The method must return the id of the parent category 057 * if the category is nested. If it is on top level, <code>null</code> should be 058 * returned.<p> 059 * 060 * @return the parentId 061 */ 062 String getParentId(); 063 064 /** 065 * Returns the priority.<p> 066 * 067 * If more than one category with the same id is present, the one with higher priority 068 * is shown. The other categories with this id are discarded.<p> 069 * 070 * @return the priority 071 */ 072 int getPriority(); 073 074}