View Javadoc

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