IShortcutManager.java

/*
*
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
* This file is part of jAPS software.
* jAPS is a free software; 
* you can redistribute it and/or modify it
* under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; version 2.
* 
* See the file License for the specific language governing permissions   
* and limitations under the License
* 
* 
* 
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
*/
package com.agiletec.apsadmin.system.services.shortcut;

import java.util.List;

import com.agiletec.aps.system.exception.ApsSystemException;
import com.agiletec.aps.system.services.user.UserDetails;
import com.agiletec.apsadmin.system.services.shortcut.model.Shortcut;
import com.agiletec.apsadmin.system.services.shortcut.model.UserConfigBean;

/**
 * Interface of the manager of Shortcut catalog and user config.
 * @author E.Santoboni
 */
public interface IShortcutManager {
	
	/**
	 * Save a shortcut config of the given user.
	 * The saved config shold be not equals than the given, the invalid position 
	 * (with invalid shortcut code, or with shortcut not allowed to the user) will be emptied.
	 * @param user The user owner of the config to save.
	 * @param config The config to save.
	 * @return The saved config.
	 * @throws ApsSystemException In case of error.
	 */
	public String[] saveUserConfig(UserDetails user, String[] config) throws ApsSystemException;
	
	/**
	 * Save a shortcut config of the given user.
	 * The saved config shold be not equals than the given, the invalid position 
	 * (with invalid shortcut code, or with shortcut not allowed to the user) will be emptied.
	 * @param user The user owner of the config to save.
	 * @param config The config to save.
	 * @return The saved config.
	 * @throws ApsSystemException In case of error.
	 */
	public UserConfigBean saveUserConfigBean(UserDetails user, UserConfigBean userConfig) throws ApsSystemException;
	
	/**
	 * Return the size of the box that contains the user shortcuts.
	 * @return The size.
	 */
	public Integer getUserShortcutsMaxNumber();
	
	/**
	 * Return the shorcut config of the given user.
	 * The config contains only the shortcut allowed.
	 * @param user The user that require the config.
	 * @return The config of the given user.
	 * @throws ApsSystemException In case of error.
	 */
	public String[] getUserConfig(UserDetails user) throws ApsSystemException;
	
	/**
	 * Return the shorcut config of the given user.
	 * The config contains only the shortcut allowed.
	 * @param user The user that require the config.
	 * @return The user config of the given user.
	 * @throws ApsSystemException In case of error.
	 */
	public UserConfigBean getUserConfigBean(UserDetails user) throws ApsSystemException;
	
	/**
	 * Delete a config by user
	 * @param username The username of the config to delete.
	 * @throws ApsSystemException In case of error.
	 */
	public void deleteUserConfig(String username) throws ApsSystemException;
	
	/**
	 * Return the list of the allowed shortcuts to the given user.
	 * @param user The user making the request
	 * @return The list of the allowed shortcut
	 * @throws ApsSystemException In case of error.
	 */
	public List<Shortcut> getAllowedShortcuts(UserDetails user) throws ApsSystemException;
	
	/**
	 * Return a shortcut by code.
	 * @param code The code of the shortcut to return.
	 * @return The searched shortcut.
	 */
	public Shortcut getShortcut(String code);
	
	public static final String SHORTCUT_INSPECT_DIRS = "/WEB-INF/apsadmin/shortcut.xml,/WEB-INF/**/**/apsadmin/shortcut.xml";
	
}