fr.ifremer.allegro.referential
Interface NearbySpecificAreaDao

All Known Implementing Classes:
NearbySpecificAreaDaoBase, NearbySpecificAreaDaoImpl

public interface NearbySpecificAreaDao

See Also:
NearbySpecificArea

Field Summary
static int TRANSFORM_CLUSTERNEARBYSPECIFICAREA
          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_REMOTENEARBYSPECIFICAREAFULLVO
          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_REMOTENEARBYSPECIFICAREANATURALID
          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
 NearbySpecificArea clusterNearbySpecificAreaToEntity(ClusterNearbySpecificArea clusterNearbySpecificArea)
          Converts an instance of type ClusterNearbySpecificArea to this DAO's entity.
 void clusterNearbySpecificAreaToEntity(ClusterNearbySpecificArea source, NearbySpecificArea target, boolean copyIfNull)
          Copies the fields of ClusterNearbySpecificArea to the specified entity.
 void clusterNearbySpecificAreaToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type ClusterNearbySpecificArea to this DAO's entity.
 java.util.Collection create(java.util.Collection entities)
          Creates a new instance of fr.ifremer.allegro.referential.NearbySpecificArea 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.NearbySpecificArea) with an additional flag called transform.
 java.lang.Object create(int transform, NearbySpecificArea nearbySpecificArea)
           Does the same thing as create(fr.ifremer.allegro.referential.NearbySpecificArea) with an additional flag called transform.
 java.lang.Object create(int transform, java.lang.String description, java.lang.String name, Status status)
           Does the same thing as create(java.lang.String,java.lang.String,fr.ifremer.allegro.referential.Status) with an additional flag called transform.
 java.lang.Object create(int transform, java.lang.String name, java.lang.String description, java.sql.Timestamp updateDate, Status status)
           Does the same thing as create(java.lang.String,java.lang.String,java.sql.Timestamp,fr.ifremer.allegro.referential.Status) with an additional flag called transform.
 NearbySpecificArea create(NearbySpecificArea nearbySpecificArea)
          Creates an instance of fr.ifremer.allegro.referential.NearbySpecificArea and adds it to the persistent store.
 NearbySpecificArea create(java.lang.String description, java.lang.String name, Status status)
           Creates a new fr.ifremer.allegro.referential.NearbySpecificArea instance from only required properties (attributes and association ends) and adds it to the persistent store.
 NearbySpecificArea create(java.lang.String name, java.lang.String description, java.sql.Timestamp updateDate, Status status)
           Creates a new fr.ifremer.allegro.referential.NearbySpecificArea instance from all attributes and properties and adds it to the persistent store.
 NearbySpecificArea createFromClusterNearbySpecificArea(ClusterNearbySpecificArea clusterNearbySpecificArea)
           
 NearbySpecificArea findNearbySpecificAreaById(java.lang.Integer id)
           
 java.lang.Object findNearbySpecificAreaById(int transform, java.lang.Integer id)
           Does the same thing as findNearbySpecificAreaById(java.lang.Integer) with an additional flag called transform.
 java.lang.Object findNearbySpecificAreaById(int transform, java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findNearbySpecificAreaById(int, java.lang.Integer) with an additional argument called queryString.
 NearbySpecificArea findNearbySpecificAreaById(java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findNearbySpecificAreaById(java.lang.Integer) with an additional argument called queryString.
 NearbySpecificArea findNearbySpecificAreaByNaturalId(java.lang.Integer id)
           
 java.lang.Object findNearbySpecificAreaByNaturalId(int transform, java.lang.Integer id)
           Does the same thing as findNearbySpecificAreaByNaturalId(java.lang.Integer) with an additional flag called transform.
 java.lang.Object findNearbySpecificAreaByNaturalId(int transform, java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findNearbySpecificAreaByNaturalId(int, java.lang.Integer) with an additional argument called queryString.
 NearbySpecificArea findNearbySpecificAreaByNaturalId(java.lang.String queryString, java.lang.Integer id)
           Does the same thing as findNearbySpecificAreaByNaturalId(java.lang.Integer) with an additional argument called queryString.
 java.util.Collection findNearbySpecificAreaByStatus(int transform, int pageNumber, int pageSize, Status status)
           Does the same thing as findNearbySpecificAreaByStatus(int, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findNearbySpecificAreaByStatus(int pageNumber, int pageSize, Status status)
           Does the same thing as findNearbySpecificAreaByStatus(fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findNearbySpecificAreaByStatus(int transform, Status status)
           Does the same thing as findNearbySpecificAreaByStatus(fr.ifremer.allegro.referential.Status) with an additional flag called transform.
 java.util.Collection findNearbySpecificAreaByStatus(int transform, java.lang.String queryString, int pageNumber, int pageSize, Status status)
           Does the same thing as findNearbySpecificAreaByStatus(int, String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findNearbySpecificAreaByStatus(int transform, java.lang.String queryString, Status status)
           Does the same thing as findNearbySpecificAreaByStatus(int, fr.ifremer.allegro.referential.Status) with an additional argument called queryString.
 java.util.Collection findNearbySpecificAreaByStatus(Status status)
           
 java.util.Collection findNearbySpecificAreaByStatus(java.lang.String queryString, int pageNumber, int pageSize, Status status)
           Does the same thing as findNearbySpecificAreaByStatus(String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection findNearbySpecificAreaByStatus(java.lang.String queryString, Status status)
           Does the same thing as findNearbySpecificAreaByStatus(fr.ifremer.allegro.referential.Status) with an additional argument called queryString.
 ClusterNearbySpecificArea[] getAllClusterNearbySpecificAreaSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp, java.lang.Integer userId, java.lang.Integer[] registrationLocationIds, java.lang.Integer pageNumber, java.lang.Integer pageSize)
           
 java.util.Collection getAllNearbySpecificArea()
           
 java.util.Collection getAllNearbySpecificArea(int transform)
           Does the same thing as getAllNearbySpecificArea() with an additional flag called transform.
 java.util.Collection getAllNearbySpecificArea(int pageNumber, int pageSize)
           Does the same thing as getAllNearbySpecificArea() with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificArea(int transform, int pageNumber, int pageSize)
           Does the same thing as getAllNearbySpecificArea(int) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificArea(int transform, java.lang.String queryString)
           Does the same thing as getAllNearbySpecificArea(int) with an additional argument called queryString.
 java.util.Collection getAllNearbySpecificArea(int transform, java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as getAllNearbySpecificArea(int, String) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificArea(java.lang.String queryString)
           Does the same thing as getAllNearbySpecificArea() with an additional argument called queryString.
 java.util.Collection getAllNearbySpecificArea(java.lang.String queryString, int pageNumber, int pageSize)
           Does the same thing as getAllNearbySpecificArea(String) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(int transform, int pageNumber, int pageSize, java.sql.Timestamp updateDate)
           Does the same thing as getAllNearbySpecificAreaSinceDateSynchro(int, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(int pageNumber, int pageSize, java.sql.Timestamp updateDate)
           Does the same thing as getAllNearbySpecificAreaSinceDateSynchro(java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(int transform, java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate)
           Does the same thing as getAllNearbySpecificAreaSinceDateSynchro(int, String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(int transform, java.lang.String queryString, java.sql.Timestamp updateDate)
           Does the same thing as getAllNearbySpecificAreaSinceDateSynchro(int, java.sql.Timestamp) with an additional argument called queryString.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(int transform, java.sql.Timestamp updateDate)
           Does the same thing as getAllNearbySpecificAreaSinceDateSynchro(java.sql.Timestamp) with an additional flag called transform.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate)
           Does the same thing as getAllNearbySpecificAreaSinceDateSynchro(String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(java.lang.String queryString, java.sql.Timestamp updateDate)
           Does the same thing as getAllNearbySpecificAreaSinceDateSynchro(java.sql.Timestamp) with an additional argument called queryString.
 java.util.Collection getAllNearbySpecificAreaSinceDateSynchro(java.sql.Timestamp updateDate)
           
 NearbySpecificArea load(java.lang.Integer id)
          Loads an instance of fr.ifremer.allegro.referential.NearbySpecificArea 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 NearbySpecificArea.
 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.
 NearbySpecificArea remoteNearbySpecificAreaFullVOToEntity(RemoteNearbySpecificAreaFullVO remoteNearbySpecificAreaFullVO)
          Converts an instance of type RemoteNearbySpecificAreaFullVO to this DAO's entity.
 void remoteNearbySpecificAreaFullVOToEntity(RemoteNearbySpecificAreaFullVO source, NearbySpecificArea target, boolean copyIfNull)
          Copies the fields of RemoteNearbySpecificAreaFullVO to the specified entity.
 void remoteNearbySpecificAreaFullVOToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteNearbySpecificAreaFullVO to this DAO's entity.
 NearbySpecificArea remoteNearbySpecificAreaNaturalIdToEntity(RemoteNearbySpecificAreaNaturalId remoteNearbySpecificAreaNaturalId)
          Converts an instance of type RemoteNearbySpecificAreaNaturalId to this DAO's entity.
 void remoteNearbySpecificAreaNaturalIdToEntity(RemoteNearbySpecificAreaNaturalId source, NearbySpecificArea target, boolean copyIfNull)
          Copies the fields of RemoteNearbySpecificAreaNaturalId to the specified entity.
 void remoteNearbySpecificAreaNaturalIdToEntityCollection(java.util.Collection instances)
          Converts a Collection of instances of type RemoteNearbySpecificAreaNaturalId 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.NearbySpecificArea having the given identifier from the persistent store.
 void remove(NearbySpecificArea nearbySpecificArea)
          Removes the instance of fr.ifremer.allegro.referential.NearbySpecificArea 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.
 ClusterNearbySpecificArea toClusterNearbySpecificArea(NearbySpecificArea entity)
          Converts this DAO's entity to an object of type ClusterNearbySpecificArea.
 void toClusterNearbySpecificArea(NearbySpecificArea source, ClusterNearbySpecificArea target)
          Copies the fields of the specified entity to the target value object.
 ClusterNearbySpecificArea[] toClusterNearbySpecificAreaArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type ClusterNearbySpecificArea.
 void toClusterNearbySpecificAreaCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type ClusterNearbySpecificArea.
 RemoteNearbySpecificAreaFullVO toRemoteNearbySpecificAreaFullVO(NearbySpecificArea entity)
          Converts this DAO's entity to an object of type RemoteNearbySpecificAreaFullVO.
 void toRemoteNearbySpecificAreaFullVO(NearbySpecificArea source, RemoteNearbySpecificAreaFullVO target)
          Copies the fields of the specified entity to the target value object.
 RemoteNearbySpecificAreaFullVO[] toRemoteNearbySpecificAreaFullVOArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteNearbySpecificAreaFullVO.
 void toRemoteNearbySpecificAreaFullVOCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteNearbySpecificAreaFullVO.
 RemoteNearbySpecificAreaNaturalId toRemoteNearbySpecificAreaNaturalId(NearbySpecificArea entity)
          Converts this DAO's entity to an object of type RemoteNearbySpecificAreaNaturalId.
 void toRemoteNearbySpecificAreaNaturalId(NearbySpecificArea source, RemoteNearbySpecificAreaNaturalId target)
          Copies the fields of the specified entity to the target value object.
 RemoteNearbySpecificAreaNaturalId[] toRemoteNearbySpecificAreaNaturalIdArray(java.util.Collection entities)
          Converts this DAO's entity to an array of instances of type RemoteNearbySpecificAreaNaturalId.
 void toRemoteNearbySpecificAreaNaturalIdCollection(java.util.Collection entities)
          Converts this DAO's entity to a Collection of instances of type RemoteNearbySpecificAreaNaturalId.
 void update(java.util.Collection entities)
          Updates all instances in the entities collection in the persistent store.
 void update(NearbySpecificArea nearbySpecificArea)
          Updates the nearbySpecificArea 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_REMOTENEARBYSPECIFICAREAFULLVO

static final int TRANSFORM_REMOTENEARBYSPECIFICAREAFULLVO
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 RemoteNearbySpecificAreaFullVO.

See Also:
Constant Field Values

TRANSFORM_REMOTENEARBYSPECIFICAREANATURALID

static final int TRANSFORM_REMOTENEARBYSPECIFICAREANATURALID
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 RemoteNearbySpecificAreaNaturalId.

See Also:
Constant Field Values

TRANSFORM_CLUSTERNEARBYSPECIFICAREA

static final int TRANSFORM_CLUSTERNEARBYSPECIFICAREA
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 ClusterNearbySpecificArea.

See Also:
Constant Field Values
Method Detail

toRemoteNearbySpecificAreaFullVO

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


toRemoteNearbySpecificAreaFullVO

RemoteNearbySpecificAreaFullVO toRemoteNearbySpecificAreaFullVO(NearbySpecificArea entity)
Converts this DAO's entity to an object of type RemoteNearbySpecificAreaFullVO.


toRemoteNearbySpecificAreaFullVOCollection

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


toRemoteNearbySpecificAreaFullVOArray

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


remoteNearbySpecificAreaFullVOToEntity

void remoteNearbySpecificAreaFullVOToEntity(RemoteNearbySpecificAreaFullVO source,
                                            NearbySpecificArea target,
                                            boolean copyIfNull)
Copies the fields of RemoteNearbySpecificAreaFullVO 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.

remoteNearbySpecificAreaFullVOToEntity

NearbySpecificArea remoteNearbySpecificAreaFullVOToEntity(RemoteNearbySpecificAreaFullVO remoteNearbySpecificAreaFullVO)
Converts an instance of type RemoteNearbySpecificAreaFullVO to this DAO's entity.


remoteNearbySpecificAreaFullVOToEntityCollection

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


toRemoteNearbySpecificAreaNaturalId

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


toRemoteNearbySpecificAreaNaturalId

RemoteNearbySpecificAreaNaturalId toRemoteNearbySpecificAreaNaturalId(NearbySpecificArea entity)
Converts this DAO's entity to an object of type RemoteNearbySpecificAreaNaturalId.


toRemoteNearbySpecificAreaNaturalIdCollection

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


toRemoteNearbySpecificAreaNaturalIdArray

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


remoteNearbySpecificAreaNaturalIdToEntity

void remoteNearbySpecificAreaNaturalIdToEntity(RemoteNearbySpecificAreaNaturalId source,
                                               NearbySpecificArea target,
                                               boolean copyIfNull)
Copies the fields of RemoteNearbySpecificAreaNaturalId 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.

remoteNearbySpecificAreaNaturalIdToEntity

NearbySpecificArea remoteNearbySpecificAreaNaturalIdToEntity(RemoteNearbySpecificAreaNaturalId remoteNearbySpecificAreaNaturalId)
Converts an instance of type RemoteNearbySpecificAreaNaturalId to this DAO's entity.


remoteNearbySpecificAreaNaturalIdToEntityCollection

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


toClusterNearbySpecificArea

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


toClusterNearbySpecificArea

ClusterNearbySpecificArea toClusterNearbySpecificArea(NearbySpecificArea entity)
Converts this DAO's entity to an object of type ClusterNearbySpecificArea.


toClusterNearbySpecificAreaCollection

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


toClusterNearbySpecificAreaArray

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


clusterNearbySpecificAreaToEntity

void clusterNearbySpecificAreaToEntity(ClusterNearbySpecificArea source,
                                       NearbySpecificArea target,
                                       boolean copyIfNull)
Copies the fields of ClusterNearbySpecificArea 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.

clusterNearbySpecificAreaToEntity

NearbySpecificArea clusterNearbySpecificAreaToEntity(ClusterNearbySpecificArea clusterNearbySpecificArea)
Converts an instance of type ClusterNearbySpecificArea to this DAO's entity.


clusterNearbySpecificAreaToEntityCollection

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


load

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

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

NearbySpecificArea create(NearbySpecificArea nearbySpecificArea)
Creates an instance of fr.ifremer.allegro.referential.NearbySpecificArea and adds it to the persistent store.


create

java.lang.Object create(int transform,
                        NearbySpecificArea nearbySpecificArea)

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

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

NearbySpecificArea create(java.lang.String name,
                          java.lang.String description,
                          java.sql.Timestamp updateDate,
                          Status status)

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


create

java.lang.Object create(int transform,
                        java.lang.String name,
                        java.lang.String description,
                        java.sql.Timestamp updateDate,
                        Status status)

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

NearbySpecificArea create(java.lang.String description,
                          java.lang.String name,
                          Status status)

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


create

java.lang.Object create(int transform,
                        java.lang.String description,
                        java.lang.String name,
                        Status status)

Does the same thing as create(java.lang.String,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(NearbySpecificArea nearbySpecificArea)
Updates the nearbySpecificArea 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(NearbySpecificArea nearbySpecificArea)
Removes the instance of fr.ifremer.allegro.referential.NearbySpecificArea from the persistent store.


remove

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


remove

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


getAllNearbySpecificArea

java.util.Collection getAllNearbySpecificArea()

getAllNearbySpecificArea

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

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


getAllNearbySpecificArea

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

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


getAllNearbySpecificArea

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

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


getAllNearbySpecificArea

java.util.Collection getAllNearbySpecificArea(int transform)

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


getAllNearbySpecificArea

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

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


getAllNearbySpecificArea

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

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


getAllNearbySpecificArea

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

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


findNearbySpecificAreaById

NearbySpecificArea findNearbySpecificAreaById(java.lang.Integer id)

findNearbySpecificAreaById

NearbySpecificArea findNearbySpecificAreaById(java.lang.String queryString,
                                              java.lang.Integer id)

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


findNearbySpecificAreaById

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

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


findNearbySpecificAreaById

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

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


findNearbySpecificAreaByStatus

java.util.Collection findNearbySpecificAreaByStatus(Status status)

findNearbySpecificAreaByStatus

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

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


findNearbySpecificAreaByStatus

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

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


findNearbySpecificAreaByStatus

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

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


findNearbySpecificAreaByStatus

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

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


findNearbySpecificAreaByStatus

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

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


findNearbySpecificAreaByStatus

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

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


findNearbySpecificAreaByStatus

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

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


findNearbySpecificAreaByNaturalId

NearbySpecificArea findNearbySpecificAreaByNaturalId(java.lang.Integer id)

findNearbySpecificAreaByNaturalId

NearbySpecificArea findNearbySpecificAreaByNaturalId(java.lang.String queryString,
                                                     java.lang.Integer id)

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


findNearbySpecificAreaByNaturalId

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

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


findNearbySpecificAreaByNaturalId

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

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


getAllNearbySpecificAreaSinceDateSynchro

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

getAllNearbySpecificAreaSinceDateSynchro

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

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


getAllNearbySpecificAreaSinceDateSynchro

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

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


getAllNearbySpecificAreaSinceDateSynchro

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

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


getAllNearbySpecificAreaSinceDateSynchro

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

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


getAllNearbySpecificAreaSinceDateSynchro

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

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


getAllNearbySpecificAreaSinceDateSynchro

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

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


getAllNearbySpecificAreaSinceDateSynchro

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

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


createFromClusterNearbySpecificArea

NearbySpecificArea createFromClusterNearbySpecificArea(ClusterNearbySpecificArea clusterNearbySpecificArea)

getAllClusterNearbySpecificAreaSinceDateSynchro

ClusterNearbySpecificArea[] getAllClusterNearbySpecificAreaSinceDateSynchro(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.


Copyright © 2008-2010 IFREMER. All Rights Reserved.