fr.ifremer.allegro.referential.location
Interface LocationAreaDao

All Known Implementing Classes:
LocationAreaDaoBase, LocationAreaDaoImpl

public interface LocationAreaDao

See Also:
LocationArea

Field Summary
static int TRANSFORM_CLUSTERLOCATIONAREA
          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_REMOTELOCATIONAREAFULLVO
          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_REMOTELOCATIONAREANATURALID
          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
 LocationArea clusterLocationAreaToEntity(ClusterLocationArea clusterLocationArea)
          Converts an instance of type ClusterLocationArea to this DAO's entity.
 void clusterLocationAreaToEntity(ClusterLocationArea source, LocationArea target, boolean copyIfNull)
          Copies the fields of ClusterLocationArea to the specified entity.
 void clusterLocationAreaToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type ClusterLocationArea to this DAO's entity.
 java.util.Collection create(java.util.Collection entities)
          Creates a new instance of fr.ifremer.allegro.referential.location.LocationArea 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.LocationArea) 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, LocationArea locationArea)
           Does the same thing as create(fr.ifremer.allegro.referential.location.LocationArea) with an additional flag called transform.
 LocationArea create(Location location)
           Creates a new fr.ifremer.allegro.referential.location.LocationArea instance from all attributes and properties and adds it to the persistent store.
 LocationArea create(LocationArea locationArea)
          Creates an instance of fr.ifremer.allegro.referential.location.LocationArea and adds it to the persistent store.
 LocationArea createFromClusterLocationArea(ClusterLocationArea clusterLocationArea)
           
 LocationArea findLocationAreaById(java.lang.Integer id)
           
 java.lang.Object findLocationAreaById(int transform, java.lang.Integer id)
           Does the same thing as findLocationAreaById(java.lang.Integer) with an additional flag called transform.
 java.lang.Object findLocationAreaById(int transform, java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findLocationAreaById(int, java.lang.Integer) with an additional argument called queryString.
 LocationArea findLocationAreaById(java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findLocationAreaById(java.lang.Integer) with an additional argument called queryString.
 java.util.Collection findLocationAreaByLocation(int transform, int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationAreaByLocation(int, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationAreaByLocation(int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationAreaByLocation(fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationAreaByLocation(int transform, Location location)
           Does the same thing as findLocationAreaByLocation(fr.ifremer.allegro.referential.location.Location) with an additional flag called transform.
 java.util.Collection findLocationAreaByLocation(int transform, java.lang.String queryString, int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationAreaByLocation(int, String, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationAreaByLocation(int transform, java.lang.String queryString, Location location)
           Does the same thing as findLocationAreaByLocation(int, fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 java.util.Collection findLocationAreaByLocation(Location location)
           
 java.util.Collection findLocationAreaByLocation(java.lang.String queryString, int pageNumber, int pageSize, Location location)
           Does the same thing as findLocationAreaByLocation(String, fr.ifremer.allegro.referential.location.Location) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findLocationAreaByLocation(java.lang.String queryString, Location location)
           Does the same thing as findLocationAreaByLocation(fr.ifremer.allegro.referential.location.Location) with an additional argument called queryString.
 LocationArea findLocationAreaByNaturalId(java.lang.Integer id)
           
 java.lang.Object findLocationAreaByNaturalId(int transform, java.lang.Integer id)
           Does the same thing as findLocationAreaByNaturalId(java.lang.Integer) with an additional flag called transform.
 java.lang.Object findLocationAreaByNaturalId(int transform, java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findLocationAreaByNaturalId(int, java.lang.Integer) with an additional argument called queryString.
 LocationArea findLocationAreaByNaturalId(java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findLocationAreaByNaturalId(java.lang.Integer) with an additional argument called queryString.
 java.util.Collection getAllLocationArea()
           
 java.util.Collection getAllLocationArea(int transform)
           Does the same thing as getAllLocationArea() with an additional flag called transform.
 java.util.Collection getAllLocationArea(int pageNumber, int pageSize)
           Does the same thing as getAllLocationArea() with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationArea(int transform, int pageNumber, int pageSize)
           Does the same thing as getAllLocationArea(int) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationArea(int transform, java.lang.String queryString)
           Does the same thing as getAllLocationArea(int) with an additional argument called queryString.
 java.util.Collection getAllLocationArea(int transform, java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as getAllLocationArea(int, String) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllLocationArea(java.lang.String queryString)
           Does the same thing as getAllLocationArea() with an additional argument called queryString.
 java.util.Collection getAllLocationArea(java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as getAllLocationArea(String) with an additional two arguments called pageNumber and pageSize.
 LocationArea load(java.lang.Integer id)
          Loads an instance of fr.ifremer.allegro.referential.location.LocationArea 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 LocationArea.
 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.
 LocationArea remoteLocationAreaFullVOToEntity(RemoteLocationAreaFullVO remoteLocationAreaFullVO)
          Converts an instance of type RemoteLocationAreaFullVO to this DAO's entity.
 void remoteLocationAreaFullVOToEntity(RemoteLocationAreaFullVO source, LocationArea target, boolean copyIfNull)
          Copies the fields of RemoteLocationAreaFullVO to the specified entity.
 void remoteLocationAreaFullVOToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteLocationAreaFullVO to this DAO's entity.
 LocationArea remoteLocationAreaNaturalIdToEntity(RemoteLocationAreaNaturalId remoteLocationAreaNaturalId)
          Converts an instance of type RemoteLocationAreaNaturalId to this DAO's entity.
 void remoteLocationAreaNaturalIdToEntity(RemoteLocationAreaNaturalId source, LocationArea target, boolean copyIfNull)
          Copies the fields of RemoteLocationAreaNaturalId to the specified entity.
 void remoteLocationAreaNaturalIdToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteLocationAreaNaturalId 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.LocationArea having the given identifier from the persistent store.
 void remove(LocationArea locationArea)
          Removes the instance of fr.ifremer.allegro.referential.location.LocationArea 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.
 ClusterLocationArea toClusterLocationArea(LocationArea entity)
          Converts this DAO's entity to an object of type ClusterLocationArea.
 void toClusterLocationArea(LocationArea source, ClusterLocationArea target)
          Copies the fields of the specified entity to the target value object.
 ClusterLocationArea[] toClusterLocationAreaArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type ClusterLocationArea.
 void toClusterLocationAreaCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type ClusterLocationArea.
 RemoteLocationAreaFullVO toRemoteLocationAreaFullVO(LocationArea entity)
          Converts this DAO's entity to an object of type RemoteLocationAreaFullVO.
 void toRemoteLocationAreaFullVO(LocationArea source, RemoteLocationAreaFullVO target)
          Copies the fields of the specified entity to the target value object.
 RemoteLocationAreaFullVO[] toRemoteLocationAreaFullVOArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteLocationAreaFullVO.
 void toRemoteLocationAreaFullVOCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteLocationAreaFullVO.
 RemoteLocationAreaNaturalId toRemoteLocationAreaNaturalId(LocationArea entity)
          Converts this DAO's entity to an object of type RemoteLocationAreaNaturalId.
 void toRemoteLocationAreaNaturalId(LocationArea source, RemoteLocationAreaNaturalId target)
          Copies the fields of the specified entity to the target value object.
 RemoteLocationAreaNaturalId[] toRemoteLocationAreaNaturalIdArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteLocationAreaNaturalId.
 void toRemoteLocationAreaNaturalIdCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteLocationAreaNaturalId.
 void update(java.util.Collection entities)
          Updates all instances in the entities collection in the persistent store.
 void update(LocationArea locationArea)
          Updates the locationArea 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_REMOTELOCATIONAREAFULLVO

static final int TRANSFORM_REMOTELOCATIONAREAFULLVO
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 RemoteLocationAreaFullVO.

See Also:
Constant Field Values

TRANSFORM_REMOTELOCATIONAREANATURALID

static final int TRANSFORM_REMOTELOCATIONAREANATURALID
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 RemoteLocationAreaNaturalId.

See Also:
Constant Field Values

TRANSFORM_CLUSTERLOCATIONAREA

static final int TRANSFORM_CLUSTERLOCATIONAREA
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 ClusterLocationArea.

See Also:
Constant Field Values
Method Detail

toRemoteLocationAreaFullVO

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


toRemoteLocationAreaFullVO

RemoteLocationAreaFullVO toRemoteLocationAreaFullVO(LocationArea entity)
Converts this DAO's entity to an object of type RemoteLocationAreaFullVO.


toRemoteLocationAreaFullVOCollection

void toRemoteLocationAreaFullVOCollection(java.util.Collection entities)
Converts this DAO's entity to a Collection of instances of type RemoteLocationAreaFullVO.


toRemoteLocationAreaFullVOArray

RemoteLocationAreaFullVO[] toRemoteLocationAreaFullVOArray(java.util.Collection entities)
Converts this DAO's entity to an array of instances of type RemoteLocationAreaFullVO.


remoteLocationAreaFullVOToEntity

void remoteLocationAreaFullVOToEntity(RemoteLocationAreaFullVO source,
                                      LocationArea target,
                                      boolean copyIfNull)
Copies the fields of RemoteLocationAreaFullVO 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.

remoteLocationAreaFullVOToEntity

LocationArea remoteLocationAreaFullVOToEntity(RemoteLocationAreaFullVO remoteLocationAreaFullVO)
Converts an instance of type RemoteLocationAreaFullVO to this DAO's entity.


remoteLocationAreaFullVOToEntityCollection

void remoteLocationAreaFullVOToEntityCollection(java.util.Collection instances)
Converts a Collection of instances of type RemoteLocationAreaFullVO to this DAO's entity.


toRemoteLocationAreaNaturalId

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


toRemoteLocationAreaNaturalId

RemoteLocationAreaNaturalId toRemoteLocationAreaNaturalId(LocationArea entity)
Converts this DAO's entity to an object of type RemoteLocationAreaNaturalId.


toRemoteLocationAreaNaturalIdCollection

void toRemoteLocationAreaNaturalIdCollection(java.util.Collection entities)
Converts this DAO's entity to a Collection of instances of type RemoteLocationAreaNaturalId.


toRemoteLocationAreaNaturalIdArray

RemoteLocationAreaNaturalId[] toRemoteLocationAreaNaturalIdArray(java.util.Collection entities)
Converts this DAO's entity to an array of instances of type RemoteLocationAreaNaturalId.


remoteLocationAreaNaturalIdToEntity

void remoteLocationAreaNaturalIdToEntity(RemoteLocationAreaNaturalId source,
                                         LocationArea target,
                                         boolean copyIfNull)
Copies the fields of RemoteLocationAreaNaturalId 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.

remoteLocationAreaNaturalIdToEntity

LocationArea remoteLocationAreaNaturalIdToEntity(RemoteLocationAreaNaturalId remoteLocationAreaNaturalId)
Converts an instance of type RemoteLocationAreaNaturalId to this DAO's entity.


remoteLocationAreaNaturalIdToEntityCollection

void remoteLocationAreaNaturalIdToEntityCollection(java.util.Collection instances)
Converts a Collection of instances of type RemoteLocationAreaNaturalId to this DAO's entity.


toClusterLocationArea

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


toClusterLocationArea

ClusterLocationArea toClusterLocationArea(LocationArea entity)
Converts this DAO's entity to an object of type ClusterLocationArea.


toClusterLocationAreaCollection

void toClusterLocationAreaCollection(java.util.Collection entities)
Converts this DAO's entity to a Collection of instances of type ClusterLocationArea.


toClusterLocationAreaArray

ClusterLocationArea[] toClusterLocationAreaArray(java.util.Collection entities)
Converts this DAO's entity to an array of instances of type ClusterLocationArea.


clusterLocationAreaToEntity

void clusterLocationAreaToEntity(ClusterLocationArea source,
                                 LocationArea target,
                                 boolean copyIfNull)
Copies the fields of ClusterLocationArea 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.

clusterLocationAreaToEntity

LocationArea clusterLocationAreaToEntity(ClusterLocationArea clusterLocationArea)
Converts an instance of type ClusterLocationArea to this DAO's entity.


clusterLocationAreaToEntityCollection

void clusterLocationAreaToEntityCollection(java.util.Collection instances)
Converts a Collection of instances of type ClusterLocationArea to this DAO's entity.


load

LocationArea load(java.lang.Integer id)
Loads an instance of fr.ifremer.allegro.referential.location.LocationArea 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 LocationArea.

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

LocationArea create(LocationArea locationArea)
Creates an instance of fr.ifremer.allegro.referential.location.LocationArea and adds it to the persistent store.


create

java.lang.Object create(int transform,
                        LocationArea locationArea)

Does the same thing as create(fr.ifremer.allegro.referential.location.LocationArea) 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.LocationArea and adds from the passed in entities collection

Parameters:
entities - the collection of fr.ifremer.allegro.referential.location.LocationArea 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.LocationArea) 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

LocationArea create(Location location)

Creates a new fr.ifremer.allegro.referential.location.LocationArea instance from all attributes and properties 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.


update

void update(LocationArea locationArea)
Updates the locationArea 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(LocationArea locationArea)
Removes the instance of fr.ifremer.allegro.referential.location.LocationArea from the persistent store.


remove

void remove(java.lang.Integer id)
Removes the instance of fr.ifremer.allegro.referential.location.LocationArea having the given identifier from the persistent store.


remove

void remove(java.util.Collection entities)
Removes all entities in the given entities collection.


getAllLocationArea

java.util.Collection getAllLocationArea()

getAllLocationArea

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

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


getAllLocationArea

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

Does the same thing as getAllLocationArea() 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.


getAllLocationArea

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

Does the same thing as getAllLocationArea(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.


getAllLocationArea

java.util.Collection getAllLocationArea(int transform)

Does the same thing as getAllLocationArea() 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.


getAllLocationArea

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

Does the same thing as getAllLocationArea(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.


getAllLocationArea

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

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


getAllLocationArea

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

Does the same thing as getAllLocationArea(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.


findLocationAreaById

LocationArea findLocationAreaById(java.lang.Integer id)

findLocationAreaById

LocationArea findLocationAreaById(java.lang.String queryString,
                                  java.lang.Integer id)

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


findLocationAreaById

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

Does the same thing as findLocationAreaById(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.


findLocationAreaById

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

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


findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(Location location)

findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(java.lang.String queryString,
                                                Location location)

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


findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(int pageNumber,
                                                int pageSize,
                                                Location location)

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


findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(java.lang.String queryString,
                                                int pageNumber,
                                                int pageSize,
                                                Location location)

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


findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(int transform,
                                                Location location)

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


findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(int transform,
                                                int pageNumber,
                                                int pageSize,
                                                Location location)

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


findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(int transform,
                                                java.lang.String queryString,
                                                Location location)

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


findLocationAreaByLocation

java.util.Collection findLocationAreaByLocation(int transform,
                                                java.lang.String queryString,
                                                int pageNumber,
                                                int pageSize,
                                                Location location)

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


findLocationAreaByNaturalId

LocationArea findLocationAreaByNaturalId(java.lang.Integer id)

findLocationAreaByNaturalId

LocationArea findLocationAreaByNaturalId(java.lang.String queryString,
                                         java.lang.Integer id)

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


findLocationAreaByNaturalId

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

Does the same thing as findLocationAreaByNaturalId(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.


findLocationAreaByNaturalId

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

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


createFromClusterLocationArea

LocationArea createFromClusterLocationArea(ClusterLocationArea clusterLocationArea)

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.


Copyright © 2008-2010 IFREMER. All Rights Reserved.