fr.ifremer.allegro.referential.taxon
Interface ReferenceDocumentDao

All Known Implementing Classes:

ReferenceDocumentDaoBase, ReferenceDocumentDaoImpl

public interface ReferenceDocumentDao

See Also:

ReferenceDocument

Field Summary

static int	TRANSFORM_CLUSTERREFERENCEDOCUMENT 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_REMOTEREFERENCEDOCUMENTFULLVO 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_REMOTEREFERENCEDOCUMENTNATURALID 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

ReferenceDocument	clusterReferenceDocumentToEntity(ClusterReferenceDocument clusterReferenceDocument) Converts an instance of type ClusterReferenceDocument to this DAO's entity.
void	clusterReferenceDocumentToEntity(ClusterReferenceDocument source, ReferenceDocument target, boolean copyIfNull) Copies the fields of ClusterReferenceDocument to the specified entity.
void	clusterReferenceDocumentToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type ClusterReferenceDocument to this DAO's entity.
java.util.Collection	create(java.util.Collection entities) Creates a new instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument and adds from the passed in entities collection
ReferenceDocument	create(java.util.Collection authors, java.util.Date creationDate, java.lang.String reference, Status status) Creates a new fr.ifremer.allegro.referential.taxon.ReferenceDocument instance from only required properties (attributes and association ends) and adds it to the persistent store.
java.util.Collection	create(int transform, java.util.Collection entities) Does the same thing as create(fr.ifremer.allegro.referential.taxon.ReferenceDocument) with an additional flag called transform.
java.lang.Object	create(int transform, java.util.Collection authors, java.util.Date creationDate, java.lang.String reference, Status status) Does the same thing as create(java.util.Collection,java.util.Date,java.lang.String,fr.ifremer.allegro.referential.Status) with an additional flag called transform.
java.lang.Object	create(int transform, ReferenceDocument referenceDocument) Does the same thing as create(fr.ifremer.allegro.referential.taxon.ReferenceDocument) with an additional flag called transform.
java.lang.Object	create(int transform, java.lang.String reference, java.util.Date publicationDate, java.lang.String comments, java.util.Date creationDate, java.sql.Timestamp updateDate, java.util.Collection authors, java.util.Collection taxonInformationHistories, Status status) Does the same thing as create(java.lang.String,java.util.Date,java.lang.String,java.util.Date,java.sql.Timestamp,java.util.Collection,java.util.Collection,fr.ifremer.allegro.referential.Status) with an additional flag called transform.
ReferenceDocument	create(ReferenceDocument referenceDocument) Creates an instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument and adds it to the persistent store.
ReferenceDocument	create(java.lang.String reference, java.util.Date publicationDate, java.lang.String comments, java.util.Date creationDate, java.sql.Timestamp updateDate, java.util.Collection authors, java.util.Collection taxonInformationHistories, Status status) Creates a new fr.ifremer.allegro.referential.taxon.ReferenceDocument instance from all attributes and properties and adds it to the persistent store.
ReferenceDocument	createFromClusterReferenceDocument(ClusterReferenceDocument clusterReferenceDocument)
ReferenceDocument	findReferenceDocumentById(java.lang.Integer id)
java.lang.Object	findReferenceDocumentById(int transform, java.lang.Integer id) Does the same thing as findReferenceDocumentById(java.lang.Integer) with an additional flag called transform.
java.lang.Object	findReferenceDocumentById(int transform, java.lang.String queryString, java.lang.Integer id) Does the same thing as findReferenceDocumentById(int, java.lang.Integer) with an additional argument called queryString.
ReferenceDocument	findReferenceDocumentById(java.lang.String queryString, java.lang.Integer id) Does the same thing as findReferenceDocumentById(java.lang.Integer) with an additional argument called queryString.
ReferenceDocument	findReferenceDocumentByNaturalId(java.lang.Integer id)
java.lang.Object	findReferenceDocumentByNaturalId(int transform, java.lang.Integer id) Does the same thing as findReferenceDocumentByNaturalId(java.lang.Integer) with an additional flag called transform.
java.lang.Object	findReferenceDocumentByNaturalId(int transform, java.lang.String queryString, java.lang.Integer id) Does the same thing as findReferenceDocumentByNaturalId(int, java.lang.Integer) with an additional argument called queryString.
ReferenceDocument	findReferenceDocumentByNaturalId(java.lang.String queryString, java.lang.Integer id) Does the same thing as findReferenceDocumentByNaturalId(java.lang.Integer) with an additional argument called queryString.
java.util.Collection	findReferenceDocumentByStatus(int transform, int pageNumber, int pageSize, Status status) Does the same thing as findReferenceDocumentByStatus(int, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findReferenceDocumentByStatus(int pageNumber, int pageSize, Status status) Does the same thing as findReferenceDocumentByStatus(fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findReferenceDocumentByStatus(int transform, Status status) Does the same thing as findReferenceDocumentByStatus(fr.ifremer.allegro.referential.Status) with an additional flag called transform.
java.util.Collection	findReferenceDocumentByStatus(int transform, java.lang.String queryString, int pageNumber, int pageSize, Status status) Does the same thing as findReferenceDocumentByStatus(int, String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findReferenceDocumentByStatus(int transform, java.lang.String queryString, Status status) Does the same thing as findReferenceDocumentByStatus(int, fr.ifremer.allegro.referential.Status) with an additional argument called queryString.
java.util.Collection	findReferenceDocumentByStatus(Status status)
java.util.Collection	findReferenceDocumentByStatus(java.lang.String queryString, int pageNumber, int pageSize, Status status) Does the same thing as findReferenceDocumentByStatus(String, fr.ifremer.allegro.referential.Status) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findReferenceDocumentByStatus(java.lang.String queryString, Status status) Does the same thing as findReferenceDocumentByStatus(fr.ifremer.allegro.referential.Status) with an additional argument called queryString.
ClusterReferenceDocument[]	getAllClusterReferenceDocumentSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp, java.lang.Integer userId, java.lang.Integer[] registrationLocationIds, java.lang.Integer pageNumber, java.lang.Integer pageSize)
java.util.Collection	getAllReferenceDocument()
java.util.Collection	getAllReferenceDocument(int transform) Does the same thing as getAllReferenceDocument() with an additional flag called transform.
java.util.Collection	getAllReferenceDocument(int pageNumber, int pageSize) Does the same thing as getAllReferenceDocument() with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocument(int transform, int pageNumber, int pageSize) Does the same thing as getAllReferenceDocument(int) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocument(int transform, java.lang.String queryString) Does the same thing as getAllReferenceDocument(int) with an additional argument called queryString.
java.util.Collection	getAllReferenceDocument(int transform, java.lang.String queryString, int pageNumber, int pageSize) Does the same thing as getAllReferenceDocument(int, String) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocument(java.lang.String queryString) Does the same thing as getAllReferenceDocument() with an additional argument called queryString.
java.util.Collection	getAllReferenceDocument(java.lang.String queryString, int pageNumber, int pageSize) Does the same thing as getAllReferenceDocument(String) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(int transform, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllReferenceDocumentSinceDateSynchro(int, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(int transform, java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllReferenceDocumentSinceDateSynchro(int, String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(int transform, java.lang.String queryString, java.sql.Timestamp updateDate) Does the same thing as getAllReferenceDocumentSinceDateSynchro(int, java.sql.Timestamp) with an additional argument called queryString.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(int transform, java.sql.Timestamp updateDate) Does the same thing as getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp) with an additional flag called transform.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllReferenceDocumentSinceDateSynchro(String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(java.lang.String queryString, java.sql.Timestamp updateDate) Does the same thing as getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp) with an additional argument called queryString.
java.util.Collection	getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp updateDate)
ReferenceDocument	load(java.lang.Integer id) Loads an instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument 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 ReferenceDocument.
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.
ReferenceDocument	remoteReferenceDocumentFullVOToEntity(RemoteReferenceDocumentFullVO remoteReferenceDocumentFullVO) Converts an instance of type RemoteReferenceDocumentFullVO to this DAO's entity.
void	remoteReferenceDocumentFullVOToEntity(RemoteReferenceDocumentFullVO source, ReferenceDocument target, boolean copyIfNull) Copies the fields of RemoteReferenceDocumentFullVO to the specified entity.
void	remoteReferenceDocumentFullVOToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type RemoteReferenceDocumentFullVO to this DAO's entity.
ReferenceDocument	remoteReferenceDocumentNaturalIdToEntity(RemoteReferenceDocumentNaturalId remoteReferenceDocumentNaturalId) Converts an instance of type RemoteReferenceDocumentNaturalId to this DAO's entity.
void	remoteReferenceDocumentNaturalIdToEntity(RemoteReferenceDocumentNaturalId source, ReferenceDocument target, boolean copyIfNull) Copies the fields of RemoteReferenceDocumentNaturalId to the specified entity.
void	remoteReferenceDocumentNaturalIdToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type RemoteReferenceDocumentNaturalId 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.taxon.ReferenceDocument having the given identifier from the persistent store.
void	remove(ReferenceDocument referenceDocument) Removes the instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument 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.
ClusterReferenceDocument	toClusterReferenceDocument(ReferenceDocument entity) Converts this DAO's entity to an object of type ClusterReferenceDocument.
void	toClusterReferenceDocument(ReferenceDocument source, ClusterReferenceDocument target) Copies the fields of the specified entity to the target value object.
ClusterReferenceDocument[]	toClusterReferenceDocumentArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type ClusterReferenceDocument.
void	toClusterReferenceDocumentCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type ClusterReferenceDocument.
RemoteReferenceDocumentFullVO	toRemoteReferenceDocumentFullVO(ReferenceDocument entity) Converts this DAO's entity to an object of type RemoteReferenceDocumentFullVO.
void	toRemoteReferenceDocumentFullVO(ReferenceDocument source, RemoteReferenceDocumentFullVO target) Copies the fields of the specified entity to the target value object.
RemoteReferenceDocumentFullVO[]	toRemoteReferenceDocumentFullVOArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type RemoteReferenceDocumentFullVO.
void	toRemoteReferenceDocumentFullVOCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type RemoteReferenceDocumentFullVO.
RemoteReferenceDocumentNaturalId	toRemoteReferenceDocumentNaturalId(ReferenceDocument entity) Converts this DAO's entity to an object of type RemoteReferenceDocumentNaturalId.
void	toRemoteReferenceDocumentNaturalId(ReferenceDocument source, RemoteReferenceDocumentNaturalId target) Copies the fields of the specified entity to the target value object.
RemoteReferenceDocumentNaturalId[]	toRemoteReferenceDocumentNaturalIdArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type RemoteReferenceDocumentNaturalId.
void	toRemoteReferenceDocumentNaturalIdCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type RemoteReferenceDocumentNaturalId.
void	update(java.util.Collection entities) Updates all instances in the entities collection in the persistent store.
void	update(ReferenceDocument referenceDocument) Updates the referenceDocument 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_REMOTEREFERENCEDOCUMENTFULLVO

static final int TRANSFORM_REMOTEREFERENCEDOCUMENTFULLVO

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 RemoteReferenceDocumentFullVO.

See Also:

Constant Field Values

TRANSFORM_REMOTEREFERENCEDOCUMENTNATURALID

static final int TRANSFORM_REMOTEREFERENCEDOCUMENTNATURALID

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 RemoteReferenceDocumentNaturalId.

See Also:

Constant Field Values

TRANSFORM_CLUSTERREFERENCEDOCUMENT

static final int TRANSFORM_CLUSTERREFERENCEDOCUMENT

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 ClusterReferenceDocument.

See Also:

Constant Field Values

Method Detail

toRemoteReferenceDocumentFullVO

void toRemoteReferenceDocumentFullVO(ReferenceDocument source,
                                     RemoteReferenceDocumentFullVO target)

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

toRemoteReferenceDocumentFullVO

RemoteReferenceDocumentFullVO toRemoteReferenceDocumentFullVO(ReferenceDocument entity)

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

toRemoteReferenceDocumentFullVOCollection

void toRemoteReferenceDocumentFullVOCollection(java.util.Collection entities)

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

toRemoteReferenceDocumentFullVOArray

RemoteReferenceDocumentFullVO[] toRemoteReferenceDocumentFullVOArray(java.util.Collection entities)

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

remoteReferenceDocumentFullVOToEntity

void remoteReferenceDocumentFullVOToEntity(RemoteReferenceDocumentFullVO source,
                                           ReferenceDocument target,
                                           boolean copyIfNull)

Copies the fields of RemoteReferenceDocumentFullVO 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.

remoteReferenceDocumentFullVOToEntity

ReferenceDocument remoteReferenceDocumentFullVOToEntity(RemoteReferenceDocumentFullVO remoteReferenceDocumentFullVO)

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

remoteReferenceDocumentFullVOToEntityCollection

void remoteReferenceDocumentFullVOToEntityCollection(java.util.Collection instances)

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

toRemoteReferenceDocumentNaturalId

void toRemoteReferenceDocumentNaturalId(ReferenceDocument source,
                                        RemoteReferenceDocumentNaturalId target)

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

toRemoteReferenceDocumentNaturalId

RemoteReferenceDocumentNaturalId toRemoteReferenceDocumentNaturalId(ReferenceDocument entity)

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

toRemoteReferenceDocumentNaturalIdCollection

void toRemoteReferenceDocumentNaturalIdCollection(java.util.Collection entities)

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

toRemoteReferenceDocumentNaturalIdArray

RemoteReferenceDocumentNaturalId[] toRemoteReferenceDocumentNaturalIdArray(java.util.Collection entities)

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

remoteReferenceDocumentNaturalIdToEntity

void remoteReferenceDocumentNaturalIdToEntity(RemoteReferenceDocumentNaturalId source,
                                              ReferenceDocument target,
                                              boolean copyIfNull)

Copies the fields of RemoteReferenceDocumentNaturalId 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.

remoteReferenceDocumentNaturalIdToEntity

ReferenceDocument remoteReferenceDocumentNaturalIdToEntity(RemoteReferenceDocumentNaturalId remoteReferenceDocumentNaturalId)

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

remoteReferenceDocumentNaturalIdToEntityCollection

void remoteReferenceDocumentNaturalIdToEntityCollection(java.util.Collection instances)

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

toClusterReferenceDocument

void toClusterReferenceDocument(ReferenceDocument source,
                                ClusterReferenceDocument target)

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

toClusterReferenceDocument

ClusterReferenceDocument toClusterReferenceDocument(ReferenceDocument entity)

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

toClusterReferenceDocumentCollection

void toClusterReferenceDocumentCollection(java.util.Collection entities)

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

toClusterReferenceDocumentArray

ClusterReferenceDocument[] toClusterReferenceDocumentArray(java.util.Collection entities)

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

clusterReferenceDocumentToEntity

void clusterReferenceDocumentToEntity(ClusterReferenceDocument source,
                                      ReferenceDocument target,
                                      boolean copyIfNull)

Copies the fields of ClusterReferenceDocument 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.

clusterReferenceDocumentToEntity

ReferenceDocument clusterReferenceDocumentToEntity(ClusterReferenceDocument clusterReferenceDocument)

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

clusterReferenceDocumentToEntityCollection

void clusterReferenceDocumentToEntityCollection(java.util.Collection instances)

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

load

ReferenceDocument load(java.lang.Integer id)

Loads an instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument 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 ReferenceDocument.

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

ReferenceDocument create(ReferenceDocument referenceDocument)

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

create

java.lang.Object create(int transform,
                        ReferenceDocument referenceDocument)

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

Parameters:

entities - the collection of fr.ifremer.allegro.referential.taxon.ReferenceDocument 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.taxon.ReferenceDocument) 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

ReferenceDocument create(java.lang.String reference,
                         java.util.Date publicationDate,
                         java.lang.String comments,
                         java.util.Date creationDate,
                         java.sql.Timestamp updateDate,
                         java.util.Collection authors,
                         java.util.Collection taxonInformationHistories,
                         Status status)

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

create

java.lang.Object create(int transform,
                        java.lang.String reference,
                        java.util.Date publicationDate,
                        java.lang.String comments,
                        java.util.Date creationDate,
                        java.sql.Timestamp updateDate,
                        java.util.Collection authors,
                        java.util.Collection taxonInformationHistories,
                        Status status)

Does the same thing as create(java.lang.String,java.util.Date,java.lang.String,java.util.Date,java.sql.Timestamp,java.util.Collection,java.util.Collection,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

ReferenceDocument create(java.util.Collection authors,
                         java.util.Date creationDate,
                         java.lang.String reference,
                         Status status)

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

create

java.lang.Object create(int transform,
                        java.util.Collection authors,
                        java.util.Date creationDate,
                        java.lang.String reference,
                        Status status)

Does the same thing as create(java.util.Collection,java.util.Date,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(ReferenceDocument referenceDocument)

Updates the referenceDocument 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(ReferenceDocument referenceDocument)

Removes the instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument from the persistent store.

remove

void remove(java.lang.Integer id)

Removes the instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument having the given identifier from the persistent store.

remove

void remove(java.util.Collection entities)

Removes all entities in the given entities collection.

getAllReferenceDocument

java.util.Collection getAllReferenceDocument()

getAllReferenceDocument

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

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

getAllReferenceDocument

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

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

getAllReferenceDocument

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

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

getAllReferenceDocument

java.util.Collection getAllReferenceDocument(int transform)

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

getAllReferenceDocument

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

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

getAllReferenceDocument

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

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

getAllReferenceDocument

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

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

findReferenceDocumentById

ReferenceDocument findReferenceDocumentById(java.lang.Integer id)

findReferenceDocumentById

ReferenceDocument findReferenceDocumentById(java.lang.String queryString,
                                            java.lang.Integer id)

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

findReferenceDocumentById

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

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

findReferenceDocumentById

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

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

findReferenceDocumentByStatus

java.util.Collection findReferenceDocumentByStatus(Status status)

findReferenceDocumentByStatus

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

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

findReferenceDocumentByStatus

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

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

findReferenceDocumentByStatus

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

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

findReferenceDocumentByStatus

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

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

findReferenceDocumentByStatus

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

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

findReferenceDocumentByStatus

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

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

findReferenceDocumentByStatus

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

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

findReferenceDocumentByNaturalId

ReferenceDocument findReferenceDocumentByNaturalId(java.lang.Integer id)

findReferenceDocumentByNaturalId

ReferenceDocument findReferenceDocumentByNaturalId(java.lang.String queryString,
                                                   java.lang.Integer id)

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

findReferenceDocumentByNaturalId

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

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

findReferenceDocumentByNaturalId

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

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

getAllReferenceDocumentSinceDateSynchro

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

getAllReferenceDocumentSinceDateSynchro

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

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

getAllReferenceDocumentSinceDateSynchro

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

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

getAllReferenceDocumentSinceDateSynchro

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

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

getAllReferenceDocumentSinceDateSynchro

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

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

getAllReferenceDocumentSinceDateSynchro

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

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

getAllReferenceDocumentSinceDateSynchro

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

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

getAllReferenceDocumentSinceDateSynchro

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

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

createFromClusterReferenceDocument

ReferenceDocument createFromClusterReferenceDocument(ClusterReferenceDocument clusterReferenceDocument)

getAllClusterReferenceDocumentSinceDateSynchro

ClusterReferenceDocument[] getAllClusterReferenceDocumentSinceDateSynchro(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.