fr.ifremer.allegro.referential.location
Interface LocationDao

All Known Implementing Classes:

LocationDaoBase, LocationDaoImpl

public interface LocationDao

See Also:

Location

Field Summary

static int	TRANSFORM_CLUSTERLOCATION 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.
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.
static int	TRANSFORM_REMOTELOCATIONFULLVO 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.
static int	TRANSFORM_REMOTELOCATIONNATURALID 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

Location	clusterLocationToEntity(ClusterLocation clusterLocation) Converts an instance of type ClusterLocation to this DAO's entity.
void	clusterLocationToEntity(ClusterLocation source, Location target, boolean copyIfNull) Copies the fields of ClusterLocation to the specified entity.
void	clusterLocationToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type ClusterLocation to this DAO's entity.
java.util.Collection	create(java.util.Collection entities) Creates a new instance of fr.ifremer.allegro.referential.location.Location and adds from the passed in entities collection
java.util.Collection	create(int transform, java.util.Collection entities) Does the same thing as create(fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
java.lang.Object	create(int transform, Location location) Does the same thing as create(fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
java.lang.Object	create(int transform, LocationClassification locationClassification, LocationLevel locationLevel, java.lang.String name, Status status) Does the same thing as create(fr.ifremer.allegro.referential.location.LocationClassification,fr.ifremer.allegro.referential.location.LocationLevel,java.lang.String,fr.ifremer.allegro.referential.Status) with an additional flag called transform.
java.lang.Object	create(int transform, java.lang.String label, java.lang.String name, java.sql.Timestamp updateDate, LocationLevel locationLevel, LocationClassification locationClassification, Status status, java.util.Collection locationAreas, java.util.Collection locationLines, java.util.Collection locationPoints) Does the same thing as create(java.lang.String,java.lang.String,java.sql.Timestamp,fr.ifremer.allegro.referential.location.LocationLevel,fr.ifremer.allegro.referential.location.LocationClassification,fr.ifremer.allegro.referential.Status,java.util.Collection,java.util.Collection,java.util.Collection) with an additional flag called transform.
Location	create(Location location) Creates an instance of fr.ifremer.allegro.referential.location.Location and adds it to the persistent store.
Location	create(LocationClassification locationClassification, LocationLevel locationLevel, java.lang.String name, Status status) Creates a new fr.ifremer.allegro.referential.location.Location instance from only required properties (attributes and association ends) and adds it to the persistent store.
Location	create(java.lang.String label, java.lang.String name, java.sql.Timestamp updateDate, LocationLevel locationLevel, LocationClassification locationClassification, Status status, java.util.Collection locationAreas, java.util.Collection locationLines, java.util.Collection locationPoints) Creates a new fr.ifremer.allegro.referential.location.Location instance from all attributes and properties and adds it to the persistent store.
Location	createFromClusterLocation(ClusterLocation clusterLocation)
Location	findLocationById(java.lang.Integer id)
java.lang.Object	findLocationById(int transform, java.lang.Integer id) Does the same thing as findLocationById(java.lang.Integer) with an additional flag called transform.
java.lang.Object	findLocationById(int transform, java.lang.String queryString, java.lang.Integer id) Does the same thing as findLocationById(int, java.lang.Integer) with an additional argument called queryString.
Location	findLocationById(java.lang.String queryString, java.lang.Integer id) Does the same thing as findLocationById(java.lang.Integer) with an additional argument called queryString.
java.util.Collection	findLocationByLocationClassification(int transform, int pageNumber, int pageSize, LocationClassification locationClassification) Does the same thing as findLocationByLocationClassification(int, fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationClassification(int pageNumber, int pageSize, LocationClassification locationClassification) Does the same thing as findLocationByLocationClassification(fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationClassification(int transform, LocationClassification locationClassification) Does the same thing as findLocationByLocationClassification(fr.ifremer.allegro.referential.location.LocationClassification) with an additional flag called transform.
java.util.Collection	findLocationByLocationClassification(int transform, java.lang.String queryString, int pageNumber, int pageSize, LocationClassification locationClassification) Does the same thing as findLocationByLocationClassification(int, String, fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationClassification(int transform, java.lang.String queryString, LocationClassification locationClassification) Does the same thing as findLocationByLocationClassification(int, fr.ifremer.allegro.referential.location.LocationClassification) with an additional argument called queryString.
java.util.Collection	findLocationByLocationClassification(LocationClassification locationClassification)
java.util.Collection	findLocationByLocationClassification(java.lang.String queryString, int pageNumber, int pageSize, LocationClassification locationClassification) Does the same thing as findLocationByLocationClassification(String, fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationClassification(java.lang.String queryString, LocationClassification locationClassification) Does the same thing as findLocationByLocationClassification(fr.ifremer.allegro.referential.location.LocationClassification) with an additional argument called queryString.
java.util.Collection	findLocationByLocationLevel(int transform, int pageNumber, int pageSize, LocationLevel locationLevel) Does the same thing as findLocationByLocationLevel(int, fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationLevel(int pageNumber, int pageSize, LocationLevel locationLevel) Does the same thing as findLocationByLocationLevel(fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationLevel(int transform, LocationLevel locationLevel) Does the same thing as findLocationByLocationLevel(fr.ifremer.allegro.referential.location.LocationLevel) with an additional flag called transform.
java.util.Collection	findLocationByLocationLevel(int transform, java.lang.String queryString, int pageNumber, int pageSize, LocationLevel locationLevel) Does the same thing as findLocationByLocationLevel(int, String, fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationLevel(int transform, java.lang.String queryString, LocationLevel locationLevel) Does the same thing as findLocationByLocationLevel(int, fr.ifremer.allegro.referential.location.LocationLevel) with an additional argument called queryString.
java.util.Collection	findLocationByLocationLevel(LocationLevel locationLevel)
java.util.Collection	findLocationByLocationLevel(java.lang.String queryString, int pageNumber, int pageSize, LocationLevel locationLevel) Does the same thing as findLocationByLocationLevel(String, fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByLocationLevel(java.lang.String queryString, LocationLevel locationLevel) Does the same thing as findLocationByLocationLevel(fr.ifremer.allegro.referential.location.LocationLevel) with an additional argument called queryString.
Location	findLocationByNaturalId(java.lang.Integer id)
java.lang.Object	findLocationByNaturalId(int transform, java.lang.Integer id) Does the same thing as findLocationByNaturalId(java.lang.Integer) with an additional flag called transform.
java.lang.Object	findLocationByNaturalId(int transform, java.lang.String queryString, java.lang.Integer id) Does the same thing as findLocationByNaturalId(int, java.lang.Integer) with an additional argument called queryString.
Location	findLocationByNaturalId(java.lang.String queryString, java.lang.Integer id) Does the same thing as findLocationByNaturalId(java.lang.Integer) with an additional argument called queryString.
java.util.Collection	findLocationByStatus(int transform, int pageNumber, int pageSize, Status status) Does the same thing as findLocationByStatus(int, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByStatus(int pageNumber, int pageSize, Status status) Does the same thing as findLocationByStatus(fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByStatus(int transform, Status status) Does the same thing as findLocationByStatus(fr.ifremer.allegro.referential.Status) with an additional flag called transform.
java.util.Collection	findLocationByStatus(int transform, java.lang.String queryString, int pageNumber, int pageSize, Status status) Does the same thing as findLocationByStatus(int, String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByStatus(int transform, java.lang.String queryString, Status status) Does the same thing as findLocationByStatus(int, fr.ifremer.allegro.referential.Status) with an additional argument called queryString.
java.util.Collection	findLocationByStatus(Status status)
java.util.Collection	findLocationByStatus(java.lang.String queryString, int pageNumber, int pageSize, Status status) Does the same thing as findLocationByStatus(String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findLocationByStatus(java.lang.String queryString, Status status) Does the same thing as findLocationByStatus(fr.ifremer.allegro.referential.Status) with an additional argument called queryString.
ClusterLocation[]	getAllClusterLocationSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp, java.lang.Integer userId, java.lang.Integer[] registrationLocationIds, java.lang.Integer pageNumber, java.lang.Integer pageSize)
java.util.Collection	getAllLocation()
java.util.Collection	getAllLocation(int transform) Does the same thing as getAllLocation() with an additional flag called transform.
java.util.Collection	getAllLocation(int pageNumber, int pageSize) Does the same thing as getAllLocation() with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocation(int transform, int pageNumber, int pageSize) Does the same thing as getAllLocation(int) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocation(int transform, java.lang.String queryString) Does the same thing as getAllLocation(int) with an additional argument called queryString.
java.util.Collection	getAllLocation(int transform, java.lang.String queryString, int pageNumber, int pageSize) Does the same thing as getAllLocation(int, String) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocation(java.lang.String queryString) Does the same thing as getAllLocation() with an additional argument called queryString.
java.util.Collection	getAllLocation(java.lang.String queryString, int pageNumber, int pageSize) Does the same thing as getAllLocation(String) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocationSinceDateSynchro(int transform, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllLocationSinceDateSynchro(int, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocationSinceDateSynchro(int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllLocationSinceDateSynchro(java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocationSinceDateSynchro(int transform, java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllLocationSinceDateSynchro(int, String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocationSinceDateSynchro(int transform, java.lang.String queryString, java.sql.Timestamp updateDate) Does the same thing as getAllLocationSinceDateSynchro(int, java.sql.Timestamp) with an additional argument called queryString.
java.util.Collection	getAllLocationSinceDateSynchro(int transform, java.sql.Timestamp updateDate) Does the same thing as getAllLocationSinceDateSynchro(java.sql.Timestamp) with an additional flag called transform.
java.util.Collection	getAllLocationSinceDateSynchro(java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllLocationSinceDateSynchro(String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllLocationSinceDateSynchro(java.lang.String queryString, java.sql.Timestamp updateDate) Does the same thing as getAllLocationSinceDateSynchro(java.sql.Timestamp) with an additional argument called queryString.
java.util.Collection	getAllLocationSinceDateSynchro(java.sql.Timestamp updateDate)
Location	load(java.lang.Integer id) Loads an instance of fr.ifremer.allegro.referential.location.Location from the persistent store.
java.lang.Object	load(int transform, java.lang.Integer id) Does the same thing as load(java.lang.Integer) with an additional flag called transform.
java.util.Collection	loadAll() Loads all entities of type Location.
java.util.Collection	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
java.util.Collection	loadAll(int pageNumber, int pageSize) Does the same thing as loadAll() with an additional two arguments called pageNumber and pageSize.
java.util.Collection	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as loadAll(int) with an additional two arguments called pageNumber and pageSize.
Location	remoteLocationFullVOToEntity(RemoteLocationFullVO remoteLocationFullVO) Converts an instance of type RemoteLocationFullVO to this DAO's entity.
void	remoteLocationFullVOToEntity(RemoteLocationFullVO source, Location target, boolean copyIfNull) Copies the fields of RemoteLocationFullVO to the specified entity.
void	remoteLocationFullVOToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type RemoteLocationFullVO to this DAO's entity.
Location	remoteLocationNaturalIdToEntity(RemoteLocationNaturalId remoteLocationNaturalId) Converts an instance of type RemoteLocationNaturalId to this DAO's entity.
void	remoteLocationNaturalIdToEntity(RemoteLocationNaturalId source, Location target, boolean copyIfNull) Copies the fields of RemoteLocationNaturalId to the specified entity.
void	remoteLocationNaturalIdToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type RemoteLocationNaturalId to this DAO's entity.
void	remove(java.util.Collection entities) Removes all entities in the given entities collection.
void	remove(java.lang.Integer id) Removes the instance of fr.ifremer.allegro.referential.location.Location having the given identifier from the persistent store.
void	remove(Location location) Removes the instance of fr.ifremer.allegro.referential.location.Location from the persistent store.
PaginationResult	search(int transform, int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(int, fr.ifremer.allegro.Search) but with an additional two flags called pageNumber and pageSize.
PaginationResult	search(int pageNumber, int pageSize, Search search) Does the same thing as {@link #search(fr.ifremer.allegro.Search) but with an additional two flags called pageNumber and pageSize.
java.util.Set	search(int transform, Search search) Does the same thing as search(fr.ifremer.allegro.Search) but with an additional flag called transform.
java.util.Set	search(Search search) Performs a search using the parameters specified in the given search object.
ClusterLocation	toClusterLocation(Location entity) Converts this DAO's entity to an object of type ClusterLocation.
void	toClusterLocation(Location source, ClusterLocation target) Copies the fields of the specified entity to the target value object.
ClusterLocation[]	toClusterLocationArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type ClusterLocation.
void	toClusterLocationCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type ClusterLocation.
RemoteLocationFullVO	toRemoteLocationFullVO(Location entity) Converts this DAO's entity to an object of type RemoteLocationFullVO.
void	toRemoteLocationFullVO(Location source, RemoteLocationFullVO target) Copies the fields of the specified entity to the target value object.
RemoteLocationFullVO[]	toRemoteLocationFullVOArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type RemoteLocationFullVO.
void	toRemoteLocationFullVOCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type RemoteLocationFullVO.
RemoteLocationNaturalId	toRemoteLocationNaturalId(Location entity) Converts this DAO's entity to an object of type RemoteLocationNaturalId.
void	toRemoteLocationNaturalId(Location source, RemoteLocationNaturalId target) Copies the fields of the specified entity to the target value object.
RemoteLocationNaturalId[]	toRemoteLocationNaturalIdArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type RemoteLocationNaturalId.
void	toRemoteLocationNaturalIdCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type RemoteLocationNaturalId.
void	update(java.util.Collection entities) Updates all instances in the entities collection in the persistent store.
void	update(Location location) Updates the location 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

TRANSFORM_REMOTELOCATIONFULLVO

static final int TRANSFORM_REMOTELOCATIONFULLVO

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 entities must be transformed into objects of type RemoteLocationFullVO.

See Also:

Constant Field Values

TRANSFORM_REMOTELOCATIONNATURALID

static final int TRANSFORM_REMOTELOCATIONNATURALID

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 entities must be transformed into objects of type RemoteLocationNaturalId.

See Also:

Constant Field Values

TRANSFORM_CLUSTERLOCATION

static final int TRANSFORM_CLUSTERLOCATION

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 entities must be transformed into objects of type ClusterLocation.

See Also:

Constant Field Values

Method Detail

toRemoteLocationFullVO

void toRemoteLocationFullVO(Location source,
                            RemoteLocationFullVO target)

Copies the fields of the specified entity to the target value object. This method is similar to toRemoteLocationFullVO(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

toRemoteLocationFullVO

RemoteLocationFullVO toRemoteLocationFullVO(Location entity)

Converts this DAO's entity to an object of type RemoteLocationFullVO.

toRemoteLocationFullVOCollection

void toRemoteLocationFullVOCollection(java.util.Collection entities)

Converts this DAO's entity to a Collection of instances of type RemoteLocationFullVO.

toRemoteLocationFullVOArray

RemoteLocationFullVO[] toRemoteLocationFullVOArray(java.util.Collection entities)

Converts this DAO's entity to an array of instances of type RemoteLocationFullVO.

remoteLocationFullVOToEntity

void remoteLocationFullVOToEntity(RemoteLocationFullVO source,
                                  Location target,
                                  boolean copyIfNull)

Copies the fields of RemoteLocationFullVO to the specified entity.

Parameters:

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.

remoteLocationFullVOToEntity

Location remoteLocationFullVOToEntity(RemoteLocationFullVO remoteLocationFullVO)

Converts an instance of type RemoteLocationFullVO to this DAO's entity.

remoteLocationFullVOToEntityCollection

void remoteLocationFullVOToEntityCollection(java.util.Collection instances)

Converts a Collection of instances of type RemoteLocationFullVO to this DAO's entity.

toRemoteLocationNaturalId

void toRemoteLocationNaturalId(Location source,
                               RemoteLocationNaturalId target)

Copies the fields of the specified entity to the target value object. This method is similar to toRemoteLocationNaturalId(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

toRemoteLocationNaturalId

RemoteLocationNaturalId toRemoteLocationNaturalId(Location entity)

Converts this DAO's entity to an object of type RemoteLocationNaturalId.

toRemoteLocationNaturalIdCollection

void toRemoteLocationNaturalIdCollection(java.util.Collection entities)

Converts this DAO's entity to a Collection of instances of type RemoteLocationNaturalId.

toRemoteLocationNaturalIdArray

RemoteLocationNaturalId[] toRemoteLocationNaturalIdArray(java.util.Collection entities)

Converts this DAO's entity to an array of instances of type RemoteLocationNaturalId.

remoteLocationNaturalIdToEntity

void remoteLocationNaturalIdToEntity(RemoteLocationNaturalId source,
                                     Location target,
                                     boolean copyIfNull)

Copies the fields of RemoteLocationNaturalId to the specified entity.

Parameters:

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.

remoteLocationNaturalIdToEntity

Location remoteLocationNaturalIdToEntity(RemoteLocationNaturalId remoteLocationNaturalId)

Converts an instance of type RemoteLocationNaturalId to this DAO's entity.

remoteLocationNaturalIdToEntityCollection

void remoteLocationNaturalIdToEntityCollection(java.util.Collection instances)

Converts a Collection of instances of type RemoteLocationNaturalId to this DAO's entity.

toClusterLocation

void toClusterLocation(Location source,
                       ClusterLocation target)

Copies the fields of the specified entity to the target value object. This method is similar to toClusterLocation(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

toClusterLocation

ClusterLocation toClusterLocation(Location entity)

Converts this DAO's entity to an object of type ClusterLocation.

toClusterLocationCollection

void toClusterLocationCollection(java.util.Collection entities)

Converts this DAO's entity to a Collection of instances of type ClusterLocation.

toClusterLocationArray

ClusterLocation[] toClusterLocationArray(java.util.Collection entities)

Converts this DAO's entity to an array of instances of type ClusterLocation.

clusterLocationToEntity

void clusterLocationToEntity(ClusterLocation source,
                             Location target,
                             boolean copyIfNull)

Copies the fields of ClusterLocation to the specified entity.

Parameters:

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.

clusterLocationToEntity

Location clusterLocationToEntity(ClusterLocation clusterLocation)

Converts an instance of type ClusterLocation to this DAO's entity.

clusterLocationToEntityCollection

void clusterLocationToEntityCollection(java.util.Collection instances)

Converts a Collection of instances of type ClusterLocation to this DAO's entity.

load

Location load(java.lang.Integer id)

Loads an instance of fr.ifremer.allegro.referential.location.Location from the persistent store.

load

java.lang.Object load(int transform,
                      java.lang.Integer id)

Does the same thing as load(java.lang.Integer) 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 - identifier of the entity to load

Returns:

either the entity or the object transformed from the entity.

loadAll

java.util.Collection loadAll()

Loads all entities of type Location.

Returns:

the loaded entities.

loadAll

java.util.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.

loadAll

java.util.Collection loadAll(int pageNumber,
                             int pageSize)

Does the same thing as loadAll() with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

Parameters:

pageNumber - the page number to retrieve when paging results.

pageSize - the size of the page to retrieve when paging results.

Returns:

the loaded entities.

loadAll

java.util.Collection loadAll(int transform,
                             int pageNumber,
                             int pageSize)

Does the same thing as loadAll(int) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

Parameters:

transform - the flag indicating what transformation to use.

pageNumber - the page number to retrieve when paging results.

pageSize - the size of the page to retrieve when paging results.

Returns:

the loaded entities.

create

Location create(Location location)

Creates an instance of fr.ifremer.allegro.referential.location.Location and adds it to the persistent store.

create

java.lang.Object create(int transform,
                        Location location)

Does the same thing as create(fr.ifremer.allegro.referential.location.Location) 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

java.util.Collection create(java.util.Collection entities)

Creates a new instance of fr.ifremer.allegro.referential.location.Location and adds from the passed in entities collection

Parameters:

entities - the collection of fr.ifremer.allegro.referential.location.Location instances to create.

Returns:

the created instances.

create

java.util.Collection create(int transform,
                            java.util.Collection entities)

Does the same thing as create(fr.ifremer.allegro.referential.location.Location) 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

Location create(java.lang.String label,
                java.lang.String name,
                java.sql.Timestamp updateDate,
                LocationLevel locationLevel,
                LocationClassification locationClassification,
                Status status,
                java.util.Collection locationAreas,
                java.util.Collection locationLines,
                java.util.Collection locationPoints)

Creates a new fr.ifremer.allegro.referential.location.Location instance from all attributes and properties and adds it to the persistent store.

create

java.lang.Object create(int transform,
                        java.lang.String label,
                        java.lang.String name,
                        java.sql.Timestamp updateDate,
                        LocationLevel locationLevel,
                        LocationClassification locationClassification,
                        Status status,
                        java.util.Collection locationAreas,
                        java.util.Collection locationLines,
                        java.util.Collection locationPoints)

Does the same thing as create(java.lang.String,java.lang.String,java.sql.Timestamp,fr.ifremer.allegro.referential.location.LocationLevel,fr.ifremer.allegro.referential.location.LocationClassification,fr.ifremer.allegro.referential.Status,java.util.Collection,java.util.Collection,java.util.Collection) 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

Location create(LocationClassification locationClassification,
                LocationLevel locationLevel,
                java.lang.String name,
                Status status)

Creates a new fr.ifremer.allegro.referential.location.Location instance from only required properties (attributes and association ends) and adds it to the persistent store.

create

java.lang.Object create(int transform,
                        LocationClassification locationClassification,
                        LocationLevel locationLevel,
                        java.lang.String name,
                        Status status)

Does the same thing as create(fr.ifremer.allegro.referential.location.LocationClassification,fr.ifremer.allegro.referential.location.LocationLevel,java.lang.String,fr.ifremer.allegro.referential.Status) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOTWILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

update

void update(Location location)

Updates the location instance in the persistent store.

update

void update(java.util.Collection entities)

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

remove

void remove(Location location)

Removes the instance of fr.ifremer.allegro.referential.location.Location from the persistent store.

remove

void remove(java.lang.Integer id)

Removes the instance of fr.ifremer.allegro.referential.location.Location having the given identifier from the persistent store.

remove

void remove(java.util.Collection entities)

Removes all entities in the given entities collection.

getAllLocation

java.util.Collection getAllLocation()

getAllLocation

java.util.Collection getAllLocation(java.lang.String queryString)

Does the same thing as getAllLocation() with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllLocation().

getAllLocation

java.util.Collection getAllLocation(int pageNumber,
                                    int pageSize)

Does the same thing as getAllLocation() with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

getAllLocation

java.util.Collection getAllLocation(java.lang.String queryString,
                                    int pageNumber,
                                    int pageSize)

Does the same thing as getAllLocation(String) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

getAllLocation

java.util.Collection getAllLocation(int transform)

Does the same thing as getAllLocation() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

getAllLocation

java.util.Collection getAllLocation(int transform,
                                    int pageNumber,
                                    int pageSize)

Does the same thing as getAllLocation(int) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

getAllLocation

java.util.Collection getAllLocation(int transform,
                                    java.lang.String queryString)

Does the same thing as getAllLocation(int) with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllLocation(int).

getAllLocation

java.util.Collection getAllLocation(int transform,
                                    java.lang.String queryString,
                                    int pageNumber,
                                    int pageSize)

Does the same thing as getAllLocation(int, String) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationById

Location findLocationById(java.lang.Integer id)

findLocationById

Location findLocationById(java.lang.String queryString,
                          java.lang.Integer id)

Does the same thing as findLocationById(java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationById(java.lang.Integer).

findLocationById

java.lang.Object findLocationById(int transform,
                                  java.lang.Integer id)

Does the same thing as findLocationById(java.lang.Integer) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findLocationById

java.lang.Object findLocationById(int transform,
                                  java.lang.String queryString,
                                  java.lang.Integer id)

Does the same thing as findLocationById(int, java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationById(int, java.lang.Integer id).

findLocationByStatus

java.util.Collection findLocationByStatus(Status status)

findLocationByStatus

java.util.Collection findLocationByStatus(java.lang.String queryString,
                                          Status status)

Does the same thing as findLocationByStatus(fr.ifremer.allegro.referential.Status) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByStatus(fr.ifremer.allegro.referential.Status).

findLocationByStatus

java.util.Collection findLocationByStatus(int pageNumber,
                                          int pageSize,
                                          Status status)

Does the same thing as findLocationByStatus(fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByStatus

java.util.Collection findLocationByStatus(java.lang.String queryString,
                                          int pageNumber,
                                          int pageSize,
                                          Status status)

Does the same thing as findLocationByStatus(String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByStatus

java.util.Collection findLocationByStatus(int transform,
                                          Status status)

Does the same thing as findLocationByStatus(fr.ifremer.allegro.referential.Status) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findLocationByStatus

java.util.Collection findLocationByStatus(int transform,
                                          int pageNumber,
                                          int pageSize,
                                          Status status)

Does the same thing as findLocationByStatus(int, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByStatus

java.util.Collection findLocationByStatus(int transform,
                                          java.lang.String queryString,
                                          Status status)

Does the same thing as findLocationByStatus(int, fr.ifremer.allegro.referential.Status) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByStatus(int, fr.ifremer.allegro.referential.Status status).

findLocationByStatus

java.util.Collection findLocationByStatus(int transform,
                                          java.lang.String queryString,
                                          int pageNumber,
                                          int pageSize,
                                          Status status)

Does the same thing as findLocationByStatus(int, String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(LocationClassification locationClassification)

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(java.lang.String queryString,
                                                          LocationClassification locationClassification)

Does the same thing as findLocationByLocationClassification(fr.ifremer.allegro.referential.location.LocationClassification) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByLocationClassification(fr.ifremer.allegro.referential.location.LocationClassification).

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(int pageNumber,
                                                          int pageSize,
                                                          LocationClassification locationClassification)

Does the same thing as findLocationByLocationClassification(fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(java.lang.String queryString,
                                                          int pageNumber,
                                                          int pageSize,
                                                          LocationClassification locationClassification)

Does the same thing as findLocationByLocationClassification(String, fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(int transform,
                                                          LocationClassification locationClassification)

Does the same thing as findLocationByLocationClassification(fr.ifremer.allegro.referential.location.LocationClassification) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(int transform,
                                                          int pageNumber,
                                                          int pageSize,
                                                          LocationClassification locationClassification)

Does the same thing as findLocationByLocationClassification(int, fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(int transform,
                                                          java.lang.String queryString,
                                                          LocationClassification locationClassification)

Does the same thing as findLocationByLocationClassification(int, fr.ifremer.allegro.referential.location.LocationClassification) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByLocationClassification(int, fr.ifremer.allegro.referential.location.LocationClassification locationClassification).

findLocationByLocationClassification

java.util.Collection findLocationByLocationClassification(int transform,
                                                          java.lang.String queryString,
                                                          int pageNumber,
                                                          int pageSize,
                                                          LocationClassification locationClassification)

Does the same thing as findLocationByLocationClassification(int, String, fr.ifremer.allegro.referential.location.LocationClassification) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(LocationLevel locationLevel)

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(java.lang.String queryString,
                                                 LocationLevel locationLevel)

Does the same thing as findLocationByLocationLevel(fr.ifremer.allegro.referential.location.LocationLevel) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByLocationLevel(fr.ifremer.allegro.referential.location.LocationLevel).

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(int pageNumber,
                                                 int pageSize,
                                                 LocationLevel locationLevel)

Does the same thing as findLocationByLocationLevel(fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(java.lang.String queryString,
                                                 int pageNumber,
                                                 int pageSize,
                                                 LocationLevel locationLevel)

Does the same thing as findLocationByLocationLevel(String, fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(int transform,
                                                 LocationLevel locationLevel)

Does the same thing as findLocationByLocationLevel(fr.ifremer.allegro.referential.location.LocationLevel) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(int transform,
                                                 int pageNumber,
                                                 int pageSize,
                                                 LocationLevel locationLevel)

Does the same thing as findLocationByLocationLevel(int, fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(int transform,
                                                 java.lang.String queryString,
                                                 LocationLevel locationLevel)

Does the same thing as findLocationByLocationLevel(int, fr.ifremer.allegro.referential.location.LocationLevel) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByLocationLevel(int, fr.ifremer.allegro.referential.location.LocationLevel locationLevel).

findLocationByLocationLevel

java.util.Collection findLocationByLocationLevel(int transform,
                                                 java.lang.String queryString,
                                                 int pageNumber,
                                                 int pageSize,
                                                 LocationLevel locationLevel)

Does the same thing as findLocationByLocationLevel(int, String, fr.ifremer.allegro.referential.location.LocationLevel) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

findLocationByNaturalId

Location findLocationByNaturalId(java.lang.Integer id)

findLocationByNaturalId

Location findLocationByNaturalId(java.lang.String queryString,
                                 java.lang.Integer id)

Does the same thing as findLocationByNaturalId(java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByNaturalId(java.lang.Integer).

findLocationByNaturalId

java.lang.Object findLocationByNaturalId(int transform,
                                         java.lang.Integer id)

Does the same thing as findLocationByNaturalId(java.lang.Integer) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findLocationByNaturalId

java.lang.Object findLocationByNaturalId(int transform,
                                         java.lang.String queryString,
                                         java.lang.Integer id)

Does the same thing as findLocationByNaturalId(int, java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findLocationByNaturalId(int, java.lang.Integer id).

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(java.sql.Timestamp updateDate)

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(java.lang.String queryString,
                                                    java.sql.Timestamp updateDate)

Does the same thing as getAllLocationSinceDateSynchro(java.sql.Timestamp) with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllLocationSinceDateSynchro(java.sql.Timestamp).

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(int pageNumber,
                                                    int pageSize,
                                                    java.sql.Timestamp updateDate)

Does the same thing as getAllLocationSinceDateSynchro(java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(java.lang.String queryString,
                                                    int pageNumber,
                                                    int pageSize,
                                                    java.sql.Timestamp updateDate)

Does the same thing as getAllLocationSinceDateSynchro(String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(int transform,
                                                    java.sql.Timestamp updateDate)

Does the same thing as getAllLocationSinceDateSynchro(java.sql.Timestamp) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(int transform,
                                                    int pageNumber,
                                                    int pageSize,
                                                    java.sql.Timestamp updateDate)

Does the same thing as getAllLocationSinceDateSynchro(int, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(int transform,
                                                    java.lang.String queryString,
                                                    java.sql.Timestamp updateDate)

Does the same thing as getAllLocationSinceDateSynchro(int, java.sql.Timestamp) with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllLocationSinceDateSynchro(int, java.sql.Timestamp updateDate).

getAllLocationSinceDateSynchro

java.util.Collection getAllLocationSinceDateSynchro(int transform,
                                                    java.lang.String queryString,
                                                    int pageNumber,
                                                    int pageSize,
                                                    java.sql.Timestamp updateDate)

Does the same thing as getAllLocationSinceDateSynchro(int, String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.

createFromClusterLocation

Location createFromClusterLocation(ClusterLocation clusterLocation)

getAllClusterLocationSinceDateSynchro

ClusterLocation[] getAllClusterLocationSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp,
                                                        java.lang.Integer userId,
                                                        java.lang.Integer[] registrationLocationIds,
                                                        java.lang.Integer pageNumber,
                                                        java.lang.Integer pageSize)

search

PaginationResult search(int transform,
                        int pageNumber,
                        int pageSize,
                        Search search)

Does the same thing as {@link #search(int, fr.ifremer.allegro.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

Parameters:

transform - the transformation flag.

pageNumber - the page number in the data to retrieve

pageSize - the size of the page to retrieve.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search wrapped in a PaginationResult instance.

search

PaginationResult search(int pageNumber,
                        int pageSize,
                        Search search)

Does the same thing as {@link #search(fr.ifremer.allegro.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size.

Parameters:

pageNumber - the page number in the data to retrieve

pageSize - the size of the page to retrieve.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search wrapped in a PaginationResult instance.

search

java.util.Set search(int transform,
                     Search search)

Does the same thing as search(fr.ifremer.allegro.Search) but with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

Parameters:

transform - the transformation flag.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.

search

java.util.Set search(Search search)

Performs a search using the parameters specified in the given search object.

Parameters:

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.