com.communote.server.persistence.user.group

Interface ExternalUserGroupDao

All Known Implementing Classes:

ExternalUserGroupDaoBase, ExternalUserGroupDaoImpl

public interface ExternalUserGroupDao

Author:

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

See Also:

ExternalUserGroup

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
Collection<ExternalUserGroup>	create(Collection<ExternalUserGroup> entities) Creates a new instance of com.communote.server.persistence.user.group.ExternalUserGroup and adds from the passed in entities collection
ExternalUserGroup	create(ExternalUserGroup externalUserGroup) Creates an instance of com.communote.server.persistence.user.group.ExternalUserGroup and adds it to the persistent store.
Collection<?>	create(int transform, Collection<ExternalUserGroup> entities) Does the same thing as create(com.communote.server.model.user.group.ExternalUserGroup) with an additional flag called transform.
Object	create(int transform, ExternalUserGroup externalUserGroup) Does the same thing as create(com.communote.server.model.user.group.ExternalUserGroup) with an additional flag called transform.
void	evict(ExternalUserGroup entity) Evicts (removes) the entity from the hibernate cache
ExternalUserGroup	findByAdditionalProperty(String additionalProperty, String externalSystemId) Get an external group by the additional property.
ExternalUserGroup	findByExternalId(String externalId, String externalSystemId)
List<ExternalUserGroup>	findBySystemId(String systemId)
List<ExternalUserGroup>	findLatestBySystemId(String externalSystemId, Long startId, int maxCount) Find the n newest external groups for the given external system ID.
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
ExternalUserGroup	load(Long id) Loads an instance of com.communote.server.persistence.user.group.ExternalUserGroup from the persistent store.
Collection<ExternalUserGroup>	loadAll() Loads all entities of type ExternalUserGroup.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Collection<ExternalUserGroup> entities) Removes all entities in the given entities collection.
void	remove(ExternalUserGroup externalUserGroup) Removes the instance of com.communote.server.persistence.user.group.ExternalUserGroup from the persistent store.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.group.ExternalUserGroup having the given identifier from the persistent store.
void	update(Collection<ExternalUserGroup> entities) Updates all instances in the entities collection in the persistent store.
void	update(ExternalUserGroup externalUserGroup) Updates the externalUserGroup instance 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

create

ExternalUserGroup create(ExternalUserGroup externalUserGroup)

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

create

Object create(int transform,
              ExternalUserGroup externalUserGroup)

Does the same thing as create(com.communote.server.model.user.group.ExternalUserGroup) 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<ExternalUserGroup> entities)

Does the same thing as create(com.communote.server.model.user.group.ExternalUserGroup) 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<ExternalUserGroup> create(Collection<ExternalUserGroup> entities)

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

Parameters:

entities - the collection of com.communote.server.persistence.user.group.ExternalUserGroup instances to create.

Returns:

the created instances.

evict

void evict(ExternalUserGroup entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findByAdditionalProperty

ExternalUserGroup findByAdditionalProperty(String additionalProperty,
                                           String externalSystemId)

Get an external group by the additional property. If more than one with the same property exists the first found will be returned.

Parameters:

additionalProperty - the additional property

externalSystemId - the ID of the external system

Returns:

the found external group or null

findByExternalId

ExternalUserGroup findByExternalId(String externalId,
                                   String externalSystemId)

findBySystemId

List<ExternalUserGroup> findBySystemId(String systemId)

findLatestBySystemId

List<ExternalUserGroup> findLatestBySystemId(String externalSystemId,
                                             Long startId,
                                             int maxCount)

Find the n newest external groups for the given external system ID. Newest in this context means that the ID of the group is higher than the startId.

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

ExternalUserGroup load(Long id)

Loads an instance of com.communote.server.persistence.user.group.ExternalUserGroup from the persistent store.

loadAll

Collection<ExternalUserGroup> loadAll()

Loads all entities of type ExternalUserGroup.

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(ExternalUserGroup externalUserGroup)

Removes the instance of com.communote.server.persistence.user.group.ExternalUserGroup from the persistent store.

remove

void remove(Collection<ExternalUserGroup> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

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

update

void update(ExternalUserGroup externalUserGroup)

Updates the externalUserGroup instance in the persistent store.

update

void update(Collection<ExternalUserGroup> entities)

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