com.communote.server.persistence.user.client

Interface ClientDao

All Known Implementing Classes:

ClientDaoBase, ClientDaoImpl

public interface ClientDao

Author:

Communote GmbH - http://www.communote.com/

See Also:

Client

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRANSFORM_NONE This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

Method Summary

Modifier and Type	Method and Description
Client	changeClientStatus(String clientId, ClientStatus newStatus, ClientStatus oldStatus)
Client	create(Client client) Creates an instance of com.communote.server.persistence.user.client.Client and adds it to the persistent store.
Collection<Client>	create(Collection<Client> entities) Creates a new instance of com.communote.server.persistence.user.client.Client and adds from the passed in entities collection
Object	create(int transform, Client client) Does the same thing as create(com.communote.server.model.client.Client) with an additional flag called transform.
Collection<?>	create(int transform, Collection<Client> entities) Does the same thing as create(com.communote.server.model.client.Client) with an additional flag called transform.
void	evict(Client entity) Evicts (removes) the entity from the hibernate cache
Client	findByClientId(String clientId) Find the client by its id
Client	findByClientIdForWriting(String clientId) Find the client by its id and obtain a write lock
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
Client	load(Long id) Loads an instance of com.communote.server.persistence.user.client.Client from the persistent store.
Collection<Client>	loadAll() Loads all entities of type Client.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Client client) Removes the instance of com.communote.server.persistence.user.client.Client from the persistent store.
void	remove(Collection<Client> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.client.Client having the given identifier from the persistent store.
void	update(Client client) Updates the client instance in the persistent store.
void	update(Collection<Client> entities) Updates all instances in the entities collection in the persistent store.

Field Detail

TRANSFORM_NONE

static final int TRANSFORM_NONE

This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes no transformation will occur.

See Also:

Constant Field Values

Method Detail

changeClientStatus

Client changeClientStatus(String clientId,
                          ClientStatus newStatus,
                          ClientStatus oldStatus)

create

Client create(Client client)

Creates an instance of com.communote.server.persistence.user.client.Client and adds it to the persistent store.

create

Object create(int transform,
              Client client)

Does the same thing as create(com.communote.server.model.client.Client) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

create

Collection<?> create(int transform,
                     Collection<Client> entities)

Does the same thing as create(com.communote.server.model.client.Client) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

create

Collection<Client> create(Collection<Client> entities)

Creates a new instance of com.communote.server.persistence.user.client.Client and adds from the passed in entities collection

Parameters:

entities - the collection of com.communote.server.persistence.user.client.Client instances to create.

Returns:

the created instances.

evict

void evict(Client entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findByClientId

Client findByClientId(String clientId)

Find the client by its id

findByClientIdForWriting

Client findByClientIdForWriting(String clientId)

Find the client by its id and obtain a write lock

load

Object load(int transform,
            Long id)

Does the same thing as load(Long) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Parameters:

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

Client load(Long id)

Loads an instance of com.communote.server.persistence.user.client.Client from the persistent store.

loadAll

Collection<Client> loadAll()

Loads all entities of type Client.

Returns:

the loaded entities.

loadAll

Collection<?> loadAll(int transform)

Does the same thing as loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

remove

void remove(Client client)

Removes the instance of com.communote.server.persistence.user.client.Client from the persistent store.

remove

void remove(Collection<Client> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

Removes the instance of com.communote.server.persistence.user.client.Client having the given identifier from the persistent store.

update

void update(Client client)

Updates the client instance in the persistent store.

update

void update(Collection<Client> entities)

Updates all instances in the entities collection in the persistent store.