ExternalUserGroupDaoBase (Communote 3.5 API)

java.lang.Object
- org.springframework.dao.support.DaoSupport
- - org.springframework.orm.hibernate3.support.HibernateDaoSupport
  - - com.communote.server.persistence.user.group.ExternalUserGroupDaoBase

All Implemented Interfaces:

ExternalUserGroupDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

ExternalUserGroupDaoImpl
```
public abstract class ExternalUserGroupDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements ExternalUserGroupDao
```
Base Spring DAO Class: is able to create, update, remove, load, and find objects of type ExternalUserGroup.

Author:

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

See Also:

ExternalUserGroup

Field Summary
- Fields inherited from class org.springframework.dao.support.DaoSupport
  logger
- Fields inherited from interface com.communote.server.persistence.user.group.ExternalUserGroupDao
  TRANSFORM_NONE

Constructor Summary

Constructors
Constructor and Description

ExternalUserGroupDaoBase()

Constructors
Constructor and Description
`ExternalUserGroupDaoBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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<ExternalUserGroup>`	`create(int transform, Collection<ExternalUserGroup> entities)` Does the same thing as `ExternalUserGroupDao.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 `ExternalUserGroupDao.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.
`protected abstract ExternalUserGroup`	`handleFindByAdditionalProperty(String additionalProperty, String externalSystemId)`
`protected abstract ExternalUserGroup`	`handleFindByExternalId(String externalId, String externalSystemId)` Performs the core logic for `findByExternalId(String, String)`
`protected abstract List<ExternalUserGroup>`	`handleFindBySystemId(String systemId)` Performs the core logic for `findBySystemId(String)`
`protected abstract List<ExternalUserGroup>`	`handleFindLatestBySystemId(String externalSystemId, Long startId, int maxCount)` Performs the core logic for `findLatestBySystemId(String, Long, int)`
`Object`	`load(int transform, Long id)` Does the same thing as `ExternalUserGroupDao.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 `ExternalUserGroupDao.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.
`protected void`	`transformEntities(int transform, Collection<?> entities)` Transforms a collection of entities using the `transformEntity(int,ExternalUserGroup)` method.
`protected Object`	`transformEntity(int transform, ExternalUserGroup entity)` Allows transformation of entities into value objects (or something else for that matter), when the `transform` flag is set to one of the constants defined in `ExternalUserGroupDao`, please note that the `ExternalUserGroupDao.TRANSFORM_NONE` constant denotes no transformation, so the entity itself will be returned.
`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.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport
checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport
afterPropertiesSet, initDao

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExternalUserGroupDaoBase
```
public ExternalUserGroupDaoBase()
```
- Method Detail
  - create
```
public Collection<ExternalUserGroup> create(Collection<ExternalUserGroup> entities)
```
    Description copied from interface: ExternalUserGroupDao
    
    Creates a new instance of com.communote.server.persistence.user.group.ExternalUserGroup and adds from the passed in entities collection
    
    Specified by:
    
    create in interface ExternalUserGroupDao
    
    Parameters:
    
    entities - the collection of com.communote.server.persistence.user.group.ExternalUserGroup instances to create.
    
    Returns:
    
    the created instances.
    
    See Also:
    
    ExternalUserGroupDao.create(Collection <ExternalUserGroup>)
  - create
```
public ExternalUserGroup create(ExternalUserGroup externalUserGroup)
```
    Description copied from interface: ExternalUserGroupDao
    
    Creates an instance of com.communote.server.persistence.user.group.ExternalUserGroup and adds it to the persistent store.
    
    Specified by:
    
    create in interface ExternalUserGroupDao
    
    See Also:
    
    ExternalUserGroupDao.create(ExternalUserGroup)
  - create
```
public Collection<ExternalUserGroup> create(int transform,
                                            Collection<ExternalUserGroup> entities)
```
    Description copied from interface: ExternalUserGroupDao
    
    Does the same thing as ExternalUserGroupDao.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.
    
    Specified by:
    
    create in interface ExternalUserGroupDao
    
    See Also:
    
    ExternalUserGroupDao#create(int, Collection)
  - create
```
public Object create(int transform,
                     ExternalUserGroup externalUserGroup)
```
    Description copied from interface: ExternalUserGroupDao
    
    Does the same thing as ExternalUserGroupDao.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.
    
    Specified by:
    
    create in interface ExternalUserGroupDao
    
    See Also:
    
    ExternalUserGroupDao.create(int transform, ExternalUserGroup)
  - evict
```
public void evict(ExternalUserGroup entity)
```
    Evicts (removes) the entity from the hibernate cache
    
    Specified by:
    
    evict in interface ExternalUserGroupDao
    
    Parameters:
    
    entity - the entity to evict
  - findByAdditionalProperty
```
public ExternalUserGroup findByAdditionalProperty(String additionalProperty,
                                                  String externalSystemId)
```
    Description copied from interface: ExternalUserGroupDao
    
    Get an external group by the additional property. If more than one with the same property exists the first found will be returned.
    
    Specified by:
    
    findByAdditionalProperty in interface ExternalUserGroupDao
    
    Parameters:
    
    additionalProperty - the additional property
    
    externalSystemId - the ID of the external system
    
    Returns:
    
    the found external group or null
  - findByExternalId
```
public ExternalUserGroup findByExternalId(String externalId,
                                          String externalSystemId)
```
    Specified by:
    
    findByExternalId in interface ExternalUserGroupDao
    
    See Also:
    
    ExternalUserGroupDao.findByExternalId(String, String)
  - findBySystemId
```
public List<ExternalUserGroup> findBySystemId(String systemId)
```
    Specified by:
    
    findBySystemId in interface ExternalUserGroupDao
    
    See Also:
    
    ExternalUserGroupDao.findBySystemId(String)
  - findLatestBySystemId
```
public List<ExternalUserGroup> findLatestBySystemId(String externalSystemId,
                                                    Long startId,
                                                    int maxCount)
```
    Description copied from interface: ExternalUserGroupDao
    
    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.
    
    Specified by:
    
    findLatestBySystemId in interface ExternalUserGroupDao
    
    See Also:
    
    ExternalUserGroupDao.findLatestBySystemId(String, Long, int)
  - handleFindByAdditionalProperty
```
protected abstract ExternalUserGroup handleFindByAdditionalProperty(String additionalProperty,
                                                                    String externalSystemId)
```
  - handleFindByExternalId
```
protected abstract ExternalUserGroup handleFindByExternalId(String externalId,
                                                            String externalSystemId)
```
    Performs the core logic for findByExternalId(String, String)
  - handleFindBySystemId
```
protected abstract List<ExternalUserGroup> handleFindBySystemId(String systemId)
```
    Performs the core logic for findBySystemId(String)
  - handleFindLatestBySystemId
```
protected abstract List<ExternalUserGroup> handleFindLatestBySystemId(String externalSystemId,
                                                                      Long startId,
                                                                      int maxCount)
```
    Performs the core logic for findLatestBySystemId(String, Long, int)
  - load
```
public Object load(int transform,
                   Long id)
```
    Description copied from interface: ExternalUserGroupDao
    
    Does the same thing as ExternalUserGroupDao.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.
    
    Specified by:
    
    load in interface ExternalUserGroupDao
    
    id - the identifier of the entity to load.
    
    Returns:
    
    either the entity or the object transformed from the entity.
    
    See Also:
    
    ExternalUserGroupDao.load(int, Long)
  - load
```
public ExternalUserGroup load(Long id)
```
    Description copied from interface: ExternalUserGroupDao
    
    Loads an instance of com.communote.server.persistence.user.group.ExternalUserGroup from the persistent store.
    
    Specified by:
    
    load in interface ExternalUserGroupDao
    
    See Also:
    
    ExternalUserGroupDao.load(Long)
  - loadAll
```
public Collection<ExternalUserGroup> loadAll()
```
    Description copied from interface: ExternalUserGroupDao
    
    Loads all entities of type ExternalUserGroup.
    
    Specified by:
    
    loadAll in interface ExternalUserGroupDao
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    ExternalUserGroupDao.loadAll()
  - loadAll
```
public Collection<?> loadAll(int transform)
```
    Description copied from interface: ExternalUserGroupDao
    
    Does the same thing as ExternalUserGroupDao.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.
    
    Specified by:
    
    loadAll in interface ExternalUserGroupDao
    
    Parameters:
    
    transform - the flag indicating what transformation to use.
    
    Returns:
    
    the loaded entities.
    
    See Also:
    
    ExternalUserGroupDao.loadAll(int)
  - remove
```
public void remove(Collection<ExternalUserGroup> entities)
```
    Description copied from interface: ExternalUserGroupDao
    
    Removes all entities in the given entities collection.
    Specified by: remove in interface ExternalUserGroupDao See Also: ExternalUserGroupDao.remove(Collection <ExternalUserGroup>)
  remove public void remove(ExternalUserGroup externalUserGroup) Description copied from interface: ExternalUserGroupDao Removes the instance of com.communote.server.persistence.user.group.ExternalUserGroup from the persistent store. Specified by: remove in interface ExternalUserGroupDao See Also: ExternalUserGroupDao.remove(ExternalUserGroup) remove public void remove(Long id) Description copied from interface: ExternalUserGroupDao Removes the instance of com.communote.server.persistence.user.group.ExternalUserGroup having the given identifier from the persistent store. Specified by: remove in interface ExternalUserGroupDao See Also: ExternalUserGroupDao.remove(Long) transformEntities protected void transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,ExternalUserGroup) method. This method does not instantiate a new collection. This method is to be used internally only. Parameters: transform - one of the constants declared in ExternalUserGroupDao entities - the collection of entities to transform See Also: transformEntity(int,ExternalUserGroup) transformEntity protected Object transformEntity(int transform, ExternalUserGroup entity) Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in ExternalUserGroupDao, please note that the ExternalUserGroupDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown ExternalUserGroupDao.TRANSFORM_NONE is assumed. Parameters: transform - one of the constants declared in ExternalUserGroupDao entity - an entity that was found Returns: the transformed entity (i.e. new value object, etc) See Also: transformEntities(int,Collection) update public void update(Collection<ExternalUserGroup> entities) Description copied from interface: ExternalUserGroupDao Updates all instances in the entities collection in the persistent store. Specified by: update in interface ExternalUserGroupDao See Also: ExternalUserGroupDao.update(Collection <ExternalUserGroup>) update public void update(ExternalUserGroup externalUserGroup) Description copied from interface: ExternalUserGroupDao Updates the externalUserGroup instance in the persistent store. Specified by: update in interface ExternalUserGroupDao See Also: ExternalUserGroupDao.update(ExternalUserGroup)

Class ExternalUserGroupDaoBase

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

Fields inherited from interface com.communote.server.persistence.user.group.ExternalUserGroupDao

Constructor Summary

Method Summary

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

Methods inherited from class org.springframework.dao.support.DaoSupport

Methods inherited from class java.lang.Object

Constructor Detail

ExternalUserGroupDaoBase

Method Detail

create

create

create

create

evict

findByAdditionalProperty

findByExternalId

findBySystemId

findLatestBySystemId

handleFindByAdditionalProperty

handleFindByExternalId

handleFindBySystemId

handleFindLatestBySystemId

load

load

loadAll

loadAll

remove

remove

remove

transformEntities

transformEntity

update

update