org.pageseeder.bridge.model

Class PSMember

java.lang.Object

org.pageseeder.bridge.model.PSMember

All Implemented Interfaces:

Serializable, PSEntity

public final class PSMember
extends Object
implements PSEntity

A PageSeeder member.

The public identifier for a member is the username.

Since:

0.2.0

Version:

0.2.1

Author:

Christophe Lauret

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PSMember() Construct a new member without an ID or username.
PSMember(Long id) Construct a new member with the specified ID.
PSMember(String username) Construct a new member with the specified username.

Method Summary

Methods

Modifier and Type	Method and Description
EntityValidity	checkValid() Known constraints on Member are based on SQL definition:
String	getEmail()
String	getFirstname()
Long	getId()
String	getIdentifier() Returns the identifier to use when connecting to PageSeeder based on the ID available.
String	getKey()
String	getSurname()
String	getUsername()
boolean	isActivated()
boolean	isIdentifiable() Determines whether the entity can be identified in PageSeeder.
boolean	isValid() Determines whether the entity is valid based on known PageSeeder constraints.
void	setActivated(boolean activated)
void	setEmail(String email)
void	setFirstname(String firstname)
void	setId(Long id)
void	setSurname(String surname)
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PSMember

public PSMember()

Construct a new member without an ID or username.

PSMember

public PSMember(Long id)

Construct a new member with the specified ID.

Parameters:

id - The ID of the member.

PSMember

public PSMember(String username)

Construct a new member with the specified username.

Parameters:

username - The username of the member.

Method Detail

getId

public Long getId()

Specified by:

getId in interface PSEntity

Returns:

the private ID of the PageSeeder entity in the database.

getKey

public String getKey()

Specified by:

getKey in interface PSEntity

Returns:

the public ID for the PageSeeder entity.

isIdentifiable

public boolean isIdentifiable()

Description copied from interface: PSEntity

Determines whether the entity can be identified in PageSeeder.

To be identifiable, the entity must have either a private id or a public id.

If the public ID does not correspond to a single attribute in PageSeeder, then a combination of attributes may be used to determine whether it is possible to identify the entity.

Specified by:

isIdentifiable in interface PSEntity

Returns:

true if the object can be identified in PageSeeder; false if it is not possible to identify the entity form its attributes or keys.

getIdentifier

public String getIdentifier()

Description copied from interface: PSEntity

Returns the identifier to use when connecting to PageSeeder based on the ID available.

When both the private and public identifier are available, the private identifier takes precedence over the public one.

When the public identifier cannot be used on its own, then only the private ID is returned.

In general, if the PSEntity.isIdentifiable() method return true, this method should return a value. When it is not the case, it should be clearly documented.

Specified by:

getIdentifier in interface PSEntity

Returns:

the identifier to use when connecting to PageSeeder.

getFirstname

public String getFirstname()

Returns:

the firstname

getSurname

public String getSurname()

Returns:

the surname

getUsername

public String getUsername()

Returns:

the username

getEmail

public String getEmail()

Returns:

the email

isActivated

public boolean isActivated()

Returns:

the activated

setId

public void setId(Long id)

Parameters:

id - the id to set

setUsername

public void setUsername(String username)

Parameters:

username - the username to set

setFirstname

public void setFirstname(String firstname)

Parameters:

firstname - the firstname to set

setSurname

public void setSurname(String surname)

Parameters:

surname - the surname to set

setActivated

public void setActivated(boolean activated)

Parameters:

activated - the activated to set

setEmail

public void setEmail(String email)

Parameters:

email - the email to set

checkValid

public EntityValidity checkValid()

Known constraints on Member are based on SQL definition:

   FirstName VARCHAR(20) NULL
   Surname VARCHAR(20) NULL
   Email VARCHAR(100) NULL
   Username VARCHAR(100) NULL
 

Determines whether this object is valid based on known PageSeeder constraints.

Specified by:

checkValid in interface PSEntity

Returns:

true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.

isValid

public boolean isValid()

Description copied from interface: PSEntity

Determines whether the entity is valid based on known PageSeeder constraints.

Specified by:

isValid in interface PSEntity

Returns:

true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.

toString

public String toString()

Overrides:

toString in class Object