com.neurosys.user.dao

Interface UserDao<U extends User>

All Superinterfaces:

FreeQuery, GenericDao<U>

All Known Implementing Classes:

EcomUserDaoImpl, RegisteredUserLoginDaoImpl, UserDaoImpl

public interface UserDao<U extends User>
extends GenericDao<U>

Dao for Users & Credentials

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIB_LIKE_NAME
static String	ATTRIB_MODULE_NAMES

Method Summary

Modifier and Type	Method and Description
Long	count(Query<U> query)
long	countRaw(String query)
void	delete(String userNameId) Remove by Id
void	deleteCredentials(String userNameId) Remove Credentials
Credentials	getCredentials(String userNameId) Fetch Credentials for a given userId.
String	getPassword(String userNameId) Fetch password for a given userId.
U	getUser(String fieldName, Object value) Quick lookup on the system to check if any user exists with the value for a given Field Name on the User object
U	getUser(String fieldName, Object value, String entityTypeName) Same as getUser(String, Object), except here one can override the default Entity type being searched for
Class<U>	getUserEntityType()
String	getUserIdFromAttribute(String attribName, String value) Sometimes we have to identify the userId from some attributes like email, phone number etc.
U	load(String userNameId) Due to the abstract nature of User the actually entity class is not known to load the actual User object.
Page<U>	loadPage(Query<U> query) Load data in paginated fashion.
Page<U>	loadPageRaw(String query, PageInfo pageInfo)
void	save(Credentials cred) Save Credentials
U	save(U user, Credentials cred) Save user & Credentials data in one transaction

Methods inherited from interface com.neurosys.dao.GenericDao

delete, delete, load, load, save

Methods inherited from interface com.neurosys.dao.FreeQuery

query, query, update

Field Detail

ATTRIB_LIKE_NAME

static final String ATTRIB_LIKE_NAME

See Also:

Constant Field Values

ATTRIB_MODULE_NAMES

static final String ATTRIB_MODULE_NAMES

See Also:

Constant Field Values

Method Detail

count

Long count(Query<U> query)
    throws Exception

Throws:

Exception

countRaw

long countRaw(String query)

getUserIdFromAttribute

String getUserIdFromAttribute(String attribName,
                              String value)

Sometimes we have to identify the userId from some attributes like email, phone number etc.

Parameters:

attribName - as String

value - as String

Returns:

loadPage

Page<U> loadPage(Query<U> query)
          throws Exception

Load data in paginated fashion. See the Dao for Query related supported Attributes.
the decision to put a a Query param within the Entity Vs a Related attribute is that, the attributes distinctly indicate that the query should consider that param and also, it supports other relations like "LIKE" etc.

An entity-attribute to be considered in a query would imply the closest match to the Object with the same exact values.

Parameters:

query -

Returns:

Page

Throws:

Exception

getUser

U getUser(String fieldName,
          Object value)
   throws Exception

Quick lookup on the system to check if any user exists with the value for a given Field Name on the User object

Parameters:

fieldName - as String

value - as Object

Returns:

U as User object or null

Throws:

Exception

getUser

U getUser(String fieldName,
          Object value,
          String entityTypeName)
   throws Exception

Same as getUser(String, Object), except here one can override the default Entity type being searched for

Parameters:

fieldName - as String

value - as Object

entityTypeName - as String (name of Entity type)

Returns:

U as User object or null

Throws:

Exception

loadPageRaw

Page<U> loadPageRaw(String query,
                    PageInfo pageInfo)
             throws Exception

Parameters:

query -

pageInfo - @Nullanble true

Returns:

Page

Throws:

Exception

getPassword

String getPassword(String userNameId)
            throws Exception

Fetch password for a given userId. If there is no result or multiple results it will throw an exception as an erroneous condition.

Parameters:

userNameId - as String; userName or email

Returns:

password as String

Throws:

Exception

getCredentials

Credentials getCredentials(String userNameId)
                    throws Exception

Fetch Credentials for a given userId. If there is no result or multiple results it will throw an exception as an erroneous condition.

Parameters:

userNameId - as String; userName or email

Returns:

Credentials object

Throws:

Exception

save

U save(U user,
       Credentials cred)

Save user & Credentials data in one transaction

Parameters:

transientObject -

cred -

Returns:

load

U load(String userNameId)
throws Exception

Due to the abstract nature of User the actually entity class is not known to load the actual User object. For this reason the implementation is responsible for finding the right object based ona n id provided to it.

Parameters:

userNameId -

Returns:

Throws:

Exception

save

void save(Credentials cred)

Save Credentials

Parameters:

cred -

deleteCredentials

void deleteCredentials(String userNameId)

Remove Credentials

delete

void delete(String userNameId)

Remove by Id

Parameters:

userNameId -

getUserEntityType

Class<U> getUserEntityType()