| java.lang.Object org.xins.common.manageable.Manageable com.mycompany.rest.api.Users
Users | public class Users extends Manageable (Code) | | Common object used to manage the users.
version: $Revision: 1.5 $ $Date: 2007/09/18 11:27:16 $ author: Anthony Goubard |
Constructor Summary | |
public | Users(API api) Constructs a new Users instance. |
Method Summary | |
final public synchronized int | addUser(String firstName, String surname) Creates a new user. | final public synchronized boolean | deleteUser(int accountNumber) Deletes the information of a user. | final public String[] | getUser(int accountNumber) Update the information of a user. | final public synchronized boolean | updateUser(int accountNumber, String firstName, String surname) Updates the information of a user. |
Users | public Users(API api)(Code) | | Constructs a new Users instance.
Parameters: api - the API to which this function belongs, guaranteed to be notnull . |
addUser | final public synchronized int addUser(String firstName, String surname)(Code) | | Creates a new user.
Parameters: firstName - the first name of the user. Parameters: surname - the surname of the user.the account number associated with this user. |
deleteUser | final public synchronized boolean deleteUser(int accountNumber)(Code) | | Deletes the information of a user.
Parameters: accountNumber - the account number of the user.true if the user has been found and has been deleted, false otherwise. |
getUser | final public String[] getUser(int accountNumber)(Code) | | Update the information of a user.
Parameters: accountNumber - the account number of the user.a String[] containing the first name and the surname of the user ornull if the user cannot be found. |
updateUser | final public synchronized boolean updateUser(int accountNumber, String firstName, String surname)(Code) | | Updates the information of a user.
Parameters: accountNumber - the account number of the user. Parameters: firstName - the first name of the user. Parameters: surname - the surname of the user.true if the user has been found and has been updated, false otherwise. |
Methods inherited from org.xins.common.manageable.Manageable | final protected void assertUsable() throws IllegalStateException(Code)(Java Doc) final public void bootstrap(PropertyReader properties) throws IllegalStateException, MissingRequiredPropertyException, InvalidPropertyValueException, BootstrapException(Code)(Java Doc) protected void bootstrapImpl(PropertyReader properties) throws MissingRequiredPropertyException, InvalidPropertyValueException, BootstrapException(Code)(Java Doc) final public void deinit() throws IllegalStateException, DeinitializationException(Code)(Java Doc) protected void deinitImpl() throws Throwable(Code)(Java Doc) final public State getState()(Code)(Java Doc) final public void init(PropertyReader properties) throws IllegalStateException, MissingRequiredPropertyException, InvalidPropertyValueException, InitializationException(Code)(Java Doc) protected void initImpl(PropertyReader properties) throws MissingRequiredPropertyException, InvalidPropertyValueException, InitializationException(Code)(Java Doc) final public boolean isBootstrapped()(Code)(Java Doc) final public boolean isUsable()(Code)(Java Doc)
|
|
|