1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.gui;
import java.awt.*;
import net.java.sip.communicator.service.protocol.*;
/**
*
* @author Yana Stamcheva
*/
public interface AccountRegistrationForm
{
/**
* Returns the protocol icon that will be shown on the left of the protocol
* name in the list, where user will choose the protocol to register to.
*
* @return a short description of the protocol.
*/
public byte[] getListIcon();
/**
* Returns the icon that will be shown on the left of the registration form.
* @return the icon that will be shown on the left of the registration form
*/
public byte[] getIcon();
/**
* Returns the protocol name that will be shown in the list, where user
* will choose the protocol to register to.
*
* @return the protocol name.
*/
public String getProtocolName();
/**
* Returns a short description of the protocol that will be shown on the
* right of the protocol name in the list, where user will choose the
* protocol to register to.
*
* @return a short description of the protocol.
*/
public String getProtocolDescription();
/**
* Returns an example string, which should indicate to the user how the
* user name should look like. For example: john@jabber.org.
* @return an example string, which should indicate to the user how the
* user name should look like.
*/
public String getUserNameExample();
/**
* Loads all data concerning the given <tt>ProtocolProviderService</tt>.
* This method is meant to be used when a modification in an already
* created account is needed.
*
* @param protocolProvider The <tt>ProtocolProviderService</tt> to
* load data from.
*/
public void loadAccount(ProtocolProviderService protocolProvider);
/**
* Returns the advanced registration form.
*
* @return the advanced registration form
*/
public Component getAdvancedForm();
/**
* Defines the operations that will be executed when the user clicks on
* the wizard "Signin" button.
* @return the <tt>ProtocolProviderService</tt> that signed in
* @throws OperationFailedException
*/
public ProtocolProviderService signin()
throws OperationFailedException;
/**
* Defines the operations that will be executed when the user clicks on
* the wizard "Signin" button.
*
* @param userName the user name to sign in with
* @param password the password to sign in with
*/
public ProtocolProviderService signin( String userName,
String password)
throws OperationFailedException;
/**
* Returns <code>true</code> if the web sign up is supported by the current
* implementation, <code>false</code> - otherwise.
* @return <code>true</code> if the web sign up is supported by the current
* implementation, <code>false</code> - otherwise
*/
public boolean isWebSignupSupported();
/**
* Defines the operation that will be executed when user clicks on the
* "Sign up" link.
* @throws UnsupportedOperationException if the web sign up operation is
* not supported by the current implementation.
*/
public void webSignup() throws UnsupportedOperationException;
/**
* Sets the modification property to indicate if this wizard is opened for
* a modification.
*
* @param isModification indicates if this wizard is opened for modification
* or for creating a new account.
*/
public void setModification(boolean isModification);
/**
* Indicates if this wizard is modifying an existing account or is creating
* a new one.
*
* @return <code>true</code> to indicate that this wizard is currently in
* modification mode, <code>false</code> - otherwise.
*/
public boolean isModification();
/**
* Indicates whether this wizard enables the simple "sign in" form shown
* when the user opens the application for the first time. The simple
* "sign in" form allows user to configure her account in one click, just
* specifying her username and password and leaving any other configuration
* as by default.
* @return <code>true</code> if the simple "Sign in" form is enabled or
* <code>false</code> otherwise.
*/
public boolean isSimpleFormEnabled();
/**
* Returns a simple account registration form that would be the first form
* shown to the user. Only if the user needs more settings she'll choose
* to open the advanced wizard, consisted by all pages.
*
* @return a simple account registration form
*/
public Component getSimpleForm();
}
|
