com.jk.application.api.Menu Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jk-application Show documentation
TBD
The newest version!
/*
 * Copyright 2002-2016 Jalal Kiswani.
 *
 * 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 com.jk.application.api;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import com.jk.security.JKPrivilige;

/**
 * The Interface Menu.
 *
 * @author Jalal Kiswani
 */
public interface Menu {

	/**
	 * Adds the.
	 *
	 * @param o
	 *            the o
	 * @return true, if successful
	 * @see java.util.ArrayList#add(java.lang.Object)
	 */
	boolean add(MenuItem o);

	/**
	 * Adds the all.
	 *
	 * @param c
	 *            the c
	 * @return true, if successful
	 * @see java.util.ArrayList#addAll(java.util.Collection)
	 */
	boolean addAll(List c);

	/**
	 * Adds the group.
	 *
	 * @param menu
	 *            the menu
	 */
	void addGroup(Menu menu);

	/**
	 * Clear.
	 *
	 * @see java.util.ArrayList#clear()
	 */
	void clear();

	/**
	 * Gets the.
	 *
	 * @param index
	 *            the index
	 * @return the menu item
	 * @see java.util.ArrayList#get(int)
	 */
	MenuItem get(int index);

	/**
	 * Gets the full qualified path.
	 *
	 * @return the full qualified path
	 */
	String getFullQualifiedPath();

	/**
	 * Gets the groups.
	 *
	 * @return the groups
	 */
	List getGroups();

	/**
	 * Gets the icon name.
	 *
	 * @return the iconName
	 */
	String getIconName();

	/**
	 * Gets the items.
	 *
	 * @return the items
	 */
	List getItems();

	/**
	 * Gets the name.
	 *
	 * @return the name
	 */
	String getName();

	/**
	 * Gets the parent module.
	 *
	 * @return the parentModule
	 */
	Module getParentModule();

	/**
	 * Gets the privilige.
	 *
	 * @return the priviligeId
	 */
	JKPrivilige getPrivilige();

	/**
	 * Inits the.
	 */
	void init();

	/**
	 * Sets the icon name.
	 *
	 * @param iconName
	 *            the iconName to set
	 */
	void setIconName(String iconName);

	/**
	 * Sets the items.
	 *
	 * @param items
	 *            the items to set
	 */
	void setItems(List items);

	/**
	 * Sets the name.
	 *
	 * @param name
	 *            the name to set
	 */
	void setName(String name);

	/**
	 * Sets the parent module.
	 *
	 * @param parentModule
	 *            the parentModule to set
	 */
	void setParentModule(Module parentModule);

	/**
	 * Size.
	 *
	 * @return the int
	 * @see java.util.ArrayList#size()
	 */
	int size();

	/**
	 * Gets the full title.
	 *
	 * @return the full title
	 */
	String getFullTitle();

	void setIndex(int index);

	int getIndex();

}