net.nowtryz.cafetapi.datas

Class Client

java.lang.Object

net.nowtryz.cafetapi.datas.CafetData

net.nowtryz.cafetapi.datas.Client

public class Client
extends CafetData

The Client object is the wich stores every client information for later use, it's generaly generated by a Data static method (such as Data.getClient(int id))

Since:

1.0

Author:

Damien

Constructor Summary

Constructors

Constructor and Description
Client() The Client object is the wich stores every client information for later use, it's generaly generated by a Data static method (such as Data.getClient(int id))
Client(int id, String email, String alias, String familyNane, String surname, boolean member, float balance, int registrationYear) The Client object is the one that stores every client information for later use, it's generaly generated by a Data static method (such as Data.getClient(int id))

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAlias() Return the alias
float	getBalance() Return the balance
String	getEmail() Return the email
Expense[]	getExpenses() Return a list of latest client's expenses
String	getFamilyNane() Return the familynane
String	getFormatedName() Returns the name like Suname NAME
int	getId() Return the id
int	getRegistrationYear() Return the registrationYear
Reload[]	getReloads() Return a list of latest client's reloads
String	getSurname() Return the firstname
int	hashCode()
boolean	isMember() Return the member
String	toString()
void	update() Update information about the client

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Client

public Client(int id,
              String email,
              String alias,
              String familyNane,
              String surname,
              boolean member,
              float balance,
              int registrationYear)

The Client object is the one that stores every client information for later use, it's generaly generated by a Data static method (such as Data.getClient(int id))

Parameters:

id - an integer, the ID of the client in the DataBase

email - the email of the client

alias - the username of the client

familyName - the familyname of the client

firstname - the firstname of the client

member - a boolean that representswhether or not the client is a member of the association and can benefits for discounts

balance - the actual balance of the client

registrationYear - the year of the client's registration

Since:

1.0

Client

public Client()

The Client object is the wich stores every client information for later use, it's generaly generated by a Data static method (such as Data.getClient(int id))

Since:

1.0

Method Detail

getId

public final int getId()

Return the id

Returns:

the id

Since:

1.0

getEmail

public final String getEmail()

Return the email

Returns:

the email

Since:

1.0

getAlias

public final String getAlias()

Return the alias

Returns:

the alias

Since:

1.0

getFamilyNane

public final String getFamilyNane()

Return the familynane

Returns:

the familynane

Since:

1.0

getSurname

public final String getSurname()

Return the firstname

Returns:

the firstname

Since:

1.0

isMember

public final boolean isMember()

Return the member

Returns:

the member

Since:

1.0

getBalance

public final float getBalance()

Return the balance

Returns:

the balance

Since:

1.0

getRegistrationYear

public final int getRegistrationYear()

Return the registrationYear

Returns:

the registrationYear

Since:

1.0

getExpenses

public final Expense[] getExpenses()
                            throws APIException,
                                   IOException

Return a list of latest client's expenses

Returns:

a list of client's expenses

Throws:

IOException

APIException

Since:

1.0

getReloads

public final Reload[] getReloads()
                          throws APIException,
                                 IOException

Return a list of latest client's reloads

Returns:

a list of client's reloads

Throws:

IOException

APIException

Since:

1.0

getFormatedName

public final String getFormatedName()

Returns the name like Suname NAME

Returns:

the formated name

Since:

1.0

toString

public String toString()

Overrides:

toString in class Object

update

public void update()
            throws APIException,
                   IOException

Update information about the client

Throws:

IOException

APIException

Since:

1.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object