KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > struts > examples > mailreader > Subscription


1 /*
2  * $Id: Subscription.java 54929 2004-10-16 16:38:42Z germuska $
3  *
4  * Copyright 1999-2004 The Apache Software Foundation.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 package org.apache.struts.examples.mailreader;
20
21 /**
22  * <p>A <strong>Subscription</strong> which is stored, along with the
23  * associated {@link User}, in a {@link UserDatabase}.</p>
24  *
25  * @version $Rev: 54929 $ $Date: 2004-10-16 09:38:42 -0700 (Sat, 16 Oct 2004) $
26  */
27
28 public interface Subscription {
29
30
31     // ------------------------------------------------------------- Properties
32
33
34     /**
35      * Return the auto-connect flag.
36      */
37     public boolean getAutoConnect();
38
39
40     /**
41      * Set the auto-connect flag.
42      *
43      * @param autoConnect The new auto-connect flag
44      */
45     public void setAutoConnect(boolean autoConnect);
46
47
48     /**
49      * Return the host name.
50      */
51     public String JavaDoc getHost();
52
53
54     /**
55      * Return the password.
56      */
57     public String JavaDoc getPassword();
58
59
60     /**
61      * Set the password.
62      *
63      * @param password The new password
64      */
65     public void setPassword(String JavaDoc password);
66
67
68     /**
69      * Return the subscription type.
70      */
71     public String JavaDoc getType();
72
73
74     /**
75      * Set the subscription type.
76      *
77      * @param type The new subscription type
78      */
79     public void setType(String JavaDoc type);
80
81
82     /**
83      * Return the {@link User} owning this Subscription.
84      */
85     public User getUser();
86
87
88     /**
89      * Return the username.
90      */
91     public String JavaDoc getUsername();
92
93
94     /**
95      * Set the username.
96      *
97      * @param username The new username
98      */
99     public void setUsername(String JavaDoc username);
100
101
102 }
103
Popular Tags