KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sslexplorer > applications > ApplicationShortcutDatabase


1 /*
2  * SSL-Explorer
3  *
4  * Copyright (C) 2003-2006 3SP LTD. All Rights Reserved
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2 of
9  * the License, or (at your option) any later version.
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19             
20 package com.sslexplorer.applications;
21
22 import java.util.List JavaDoc;
23 import java.util.Map JavaDoc;
24
25 import com.sslexplorer.extensions.types.PluginDatabase;
26
27 /**
28  * The <i>System Configuration> {@link com.sslexplorer.core.Database} implementation
29  * is responsible for storing an retrieving SSL-Explorer's Application Shortcut resources and
30  * configuration.
31  *
32  * @author James D Robinson <a HREF="mailto:james@3sp.com">&lt;james@3sp.com&gt;</a>
33  */
34 public interface ApplicationShortcutDatabase extends PluginDatabase {
35
36     /**
37      * Create a new application shortcut.
38      *
39      * @param application
40      * @param name
41      * @param description
42      * @param settings
43      * @return int the newly created resource id.
44      * @throws Exception
45      */
46     public int createApplicationShortcut(String JavaDoc application, String JavaDoc name, String JavaDoc description, Map JavaDoc settings, int realmID)
47                     throws Exception JavaDoc;
48
49     /**
50      * Get the application shortcuts with the specified application type.
51      *
52      * @param application
53      * @return List<ApplicationShortcut>
54      * @throws Exception
55      */
56     public List JavaDoc<ApplicationShortcut> getShortcuts() throws Exception JavaDoc;
57
58     /**
59      * Get the application shortcuts with the specified application type.
60      *
61      * @param application
62      * @return List<ApplicationShortcut>
63      * @throws Exception
64      */
65     public List JavaDoc<ApplicationShortcut> getShortcuts(int realmID) throws Exception JavaDoc;
66
67     /**
68      * Get the ApplicationShortcut with the specified resaource id.
69      *
70      * @param shortcutId
71      * @return ApplicationShortcut
72      * @throws Exception
73      */
74     public ApplicationShortcut getShortcut(int shortcutId) throws Exception JavaDoc;
75
76     /**
77      * Get the ApplicationShortcut with the specified resaource id.
78      * @param name
79      * @param realmID
80      * @return ApplicationShortcut
81      * @throws Exception
82      */
83     public ApplicationShortcut getShortcut(String JavaDoc name, int realmID) throws Exception JavaDoc;
84
85     /**
86      * Delete the ApplicationShortcut with the specified resource id.
87      *
88      * @param shortcutId
89      * @return ApplicationShortcut
90      * @throws Exception
91      */
92     public ApplicationShortcut deleteShortcut(int shortcutId) throws Exception JavaDoc;
93
94     /**
95      * Update the ApplicationShortcut.
96      *
97      * @param id
98      * @param name
99      * @param description
100      * @param settings
101      * @throws Exception
102      */
103     public void updateApplicationShortcut(int id, String JavaDoc name, String JavaDoc description, Map JavaDoc settings)
104                     throws Exception JavaDoc;
105
106     /**
107      * Remove the Application Shortcuts for a given application.
108      *
109      * @param applicationId
110      * @throws Exception
111      */
112     public void removeApplicationShortcuts(String JavaDoc applicationId) throws Exception JavaDoc;
113 }
Popular Tags