fr.ifremer.adagio.core.dao.data.survey.declaration

Class DeclaredDocumentReference

Object

DeclaredDocumentReference

All Implemented Interfaces:

Serializable, Comparable<DeclaredDocumentReference>

Direct Known Subclasses:

DeclaredDocumentReferenceImpl

public abstract class DeclaredDocumentReference
extends Object
implements Serializable, Comparable<DeclaredDocumentReference>

Référence du document déclaratif. Utile pour les données issu du log book électronique (flux SACAPT.)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeclaredDocumentReference.Factory Constructs new instances of DeclaredDocumentReference.

Constructor Summary

Constructors

Constructor and Description
DeclaredDocumentReference()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addChildDeclaredDocumentReferences(DeclaredDocumentReference elementToAdd) Référence du document déclaratif.
boolean	addFishingTrips(FishingTrip elementToAdd) Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.)
boolean	addSales(Sale elementToAdd) Ventes déclarées
boolean	addSurveyMeasurements(SurveyMeasurement elementToAdd) Caractéristiques additionnelles du document déclaratif.
int	compareTo(DeclaredDocumentReference o)
boolean	equals(Object object) Returns true if the argument is an DeclaredDocumentReference instance and all identifiers for this entity equal the identifiers of the argument entity.
Collection<DeclaredDocumentReference>	getChildDeclaredDocumentReferences() Référence du document déclaratif.
String	getComments() Commentaire.
Date	getControlDate()
Date	getCreationDate() Date de création de l'enquete dans le système central.
Date	getDocumentDate()
String	getFileName() Nom du fichier ayant servi à importer les données déclarées dans la base.
String	getFirstSheetNumber() Numéro du premier feuillet de la déclaration.
Collection<FishingTrip>	getFishingTrips() Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.)
Integer	getId() Identifiant interne de la référence de document déclaratif.
String	getLastSheetNumber() Numéro du dernier feuillet de la déclaration.
String	getOtherDocumentReference() Autre référence sur le document déclaratif.
DeclaredDocumentReference	getParentDeclaredDocumentReference() Référence du document déclaratif parent.
Program	getProgram() Programme d'observation à l'origine d'une collecte de données.
String	getQualificationComments()
Date	getQualificationDate()
QualityFlag	getQualityFlag() Niveau de qualité de la donnée.
Department	getRecorderDepartment() Service saisisseur
Person	getRecorderPerson() Personne liées aux données : utilisateur du système, ou observateurs, responsable de données, etc.
String	getReference() Numéro de la fiche de peche.
Collection<Sale>	getSales() Ventes déclarées
Short	getSheetCount() Nombre de feuillets dans la déclaration.
Collection<SurveyMeasurement>	getSurveyMeasurements() Caractéristiques additionnelles du document déclaratif.
Timestamp	getUpdateDate()
Date	getValidationDate()
Vessel	getVessel() Navire, ou plus généralement un usager de la ressource.
int	hashCode() Returns a hash code based on this entity's identifiers.
boolean	removeChildDeclaredDocumentReferences(DeclaredDocumentReference elementToRemove) Référence du document déclaratif.
boolean	removeFishingTrips(FishingTrip elementToRemove) Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.)
boolean	removeSales(Sale elementToRemove) Ventes déclarées
boolean	removeSurveyMeasurements(SurveyMeasurement elementToRemove) Caractéristiques additionnelles du document déclaratif.
void	setChildDeclaredDocumentReferences(Collection<DeclaredDocumentReference> childDeclaredDocumentReferencesIn) Référence du document déclaratif.
void	setComments(String commentsIn) Commentaire.
void	setControlDate(Date controlDateIn)
void	setCreationDate(Date creationDateIn) Date de création de l'enquete dans le système central.
void	setDocumentDate(Date documentDateIn)
void	setFileName(String fileNameIn) Nom du fichier ayant servi à importer les données déclarées dans la base.
void	setFirstSheetNumber(String firstSheetNumberIn) Numéro du premier feuillet de la déclaration.
void	setFishingTrips(Collection<FishingTrip> fishingTripsIn) Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.)
void	setId(Integer idIn) Identifiant interne de la référence de document déclaratif.
void	setLastSheetNumber(String lastSheetNumberIn) Numéro du dernier feuillet de la déclaration.
void	setOtherDocumentReference(String otherDocumentReferenceIn) Autre référence sur le document déclaratif.
void	setParentDeclaredDocumentReference(DeclaredDocumentReference parentDeclaredDocumentReferenceIn) Référence du document déclaratif parent.
void	setProgram(Program programIn) Programme d'observation à l'origine d'une collecte de données.
void	setQualificationComments(String qualificationCommentsIn)
void	setQualificationDate(Date qualificationDateIn)
void	setQualityFlag(QualityFlag qualityFlagIn) Niveau de qualité de la donnée.
void	setRecorderDepartment(Department recorderDepartmentIn) Service saisisseur
void	setRecorderPerson(Person recorderPersonIn) Personne liées aux données : utilisateur du système, ou observateurs, responsable de données, etc.
void	setReference(String referenceIn) Numéro de la fiche de peche.
void	setSales(Collection<Sale> salesIn) Ventes déclarées
void	setSheetCount(Short sheetCountIn) Nombre de feuillets dans la déclaration.
void	setSurveyMeasurements(Collection<SurveyMeasurement> surveyMeasurementsIn) Caractéristiques additionnelles du document déclaratif.
void	setUpdateDate(Timestamp updateDateIn)
void	setValidationDate(Date validationDateIn)
void	setVessel(Vessel vesselIn) Navire, ou plus généralement un usager de la ressource.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeclaredDocumentReference

public DeclaredDocumentReference()

Method Detail

getId

public Integer getId()

Identifiant interne de la référence de document déclaratif. Généré par le système.

Returns:

this.id Integer

setId

public void setId(Integer idIn)

Identifiant interne de la référence de document déclaratif. Généré par le système.

Parameters:

idIn - Integer

getReference

public String getReference()

Numéro de la fiche de peche. issu du flux SACAPT. Cela sert à regrouper les marées par fiche de peche.

Returns:

this.reference String

setReference

public void setReference(String referenceIn)

Numéro de la fiche de peche. issu du flux SACAPT. Cela sert à regrouper les marées par fiche de peche.

Parameters:

referenceIn - String

getFileName

public String getFileName()

Nom du fichier ayant servi à importer les données déclarées dans la base. ex : Nom du fichier d'origine de la vente = BL_070212_1215.ric

Returns:

this.fileName String

setFileName

public void setFileName(String fileNameIn)

Nom du fichier ayant servi à importer les données déclarées dans la base. ex : Nom du fichier d'origine de la vente = BL_070212_1215.ric

Parameters:

fileNameIn - String

getDocumentDate

public Date getDocumentDate()

Returns:

this.documentDate Date

setDocumentDate

public void setDocumentDate(Date documentDateIn)

Parameters:

documentDateIn - Date

getOtherDocumentReference

public String getOtherDocumentReference()

Autre référence sur le document déclaratif. Utilisé dans SACROIS/RIC2 : Ce code permet de transmettre dans le fichier RIC2 l’information renseignée sur la note de vente dans la case « Document joint à la note de vente (le cas échéant) » : T2M/Déclaration de débarquement, document de transport, déclaration de prise en charge. Ce code permet de préciser, lorsqu’aucun document n’est joint à la note de vente, si ce défaut de document joint est ou non une anomalie du point de vue de la réglementation. Exemple : - 0 : aucun document joint à la note de vente – sans objet - 1 : aucun document joint à la note de vente – anomalie réglementaire - 2 : T2M / déclaration de débarquement - 3 : Document de transport - 4 : Déclaration de prise en charge

Returns:

this.otherDocumentReference String

setOtherDocumentReference

public void setOtherDocumentReference(String otherDocumentReferenceIn)

Autre référence sur le document déclaratif. Utilisé dans SACROIS/RIC2 : Ce code permet de transmettre dans le fichier RIC2 l’information renseignée sur la note de vente dans la case « Document joint à la note de vente (le cas échéant) » : T2M/Déclaration de débarquement, document de transport, déclaration de prise en charge. Ce code permet de préciser, lorsqu’aucun document n’est joint à la note de vente, si ce défaut de document joint est ou non une anomalie du point de vue de la réglementation. Exemple : - 0 : aucun document joint à la note de vente – sans objet - 1 : aucun document joint à la note de vente – anomalie réglementaire - 2 : T2M / déclaration de débarquement - 3 : Document de transport - 4 : Déclaration de prise en charge

Parameters:

otherDocumentReferenceIn - String

getFirstSheetNumber

public String getFirstSheetNumber()

Numéro du premier feuillet de la déclaration. Utilisé dans SACROIS/SIPA. Il peut s'agir d'un code alphanumérique (référence du feuillet).

Returns:

this.firstSheetNumber String

setFirstSheetNumber

public void setFirstSheetNumber(String firstSheetNumberIn)

Numéro du premier feuillet de la déclaration. Utilisé dans SACROIS/SIPA. Il peut s'agir d'un code alphanumérique (référence du feuillet).

Parameters:

firstSheetNumberIn - String

getLastSheetNumber

public String getLastSheetNumber()

Numéro du dernier feuillet de la déclaration. Utilisé dans SACROIS/SIPA. Il peut s'agir d'un code alphanumérique (référence du feuillet).

Returns:

this.lastSheetNumber String

setLastSheetNumber

public void setLastSheetNumber(String lastSheetNumberIn)

Numéro du dernier feuillet de la déclaration. Utilisé dans SACROIS/SIPA. Il peut s'agir d'un code alphanumérique (référence du feuillet).

Parameters:

lastSheetNumberIn - String

getSheetCount

public Short getSheetCount()

Nombre de feuillets dans la déclaration. Utilisé dans SACROIS/SIPA

Returns:

this.sheetCount Short

setSheetCount

public void setSheetCount(Short sheetCountIn)

Nombre de feuillets dans la déclaration. Utilisé dans SACROIS/SIPA

Parameters:

sheetCountIn - Short

getComments

public String getComments()

Commentaire.

Returns:

this.comments String

setComments

public void setComments(String commentsIn)

Commentaire.

Parameters:

commentsIn - String

getCreationDate

public Date getCreationDate()

Date de création de l'enquete dans le système central.

Returns:

this.creationDate Date

setCreationDate

public void setCreationDate(Date creationDateIn)

Date de création de l'enquete dans le système central.

Parameters:

creationDateIn - Date

getControlDate

public Date getControlDate()

Returns:

this.controlDate Date

setControlDate

public void setControlDate(Date controlDateIn)

Parameters:

controlDateIn - Date

getValidationDate

public Date getValidationDate()

Returns:

this.validationDate Date

setValidationDate

public void setValidationDate(Date validationDateIn)

Parameters:

validationDateIn - Date

getQualificationDate

public Date getQualificationDate()

Returns:

this.qualificationDate Date

setQualificationDate

public void setQualificationDate(Date qualificationDateIn)

Parameters:

qualificationDateIn - Date

getQualificationComments

public String getQualificationComments()

Returns:

this.qualificationComments String

setQualificationComments

public void setQualificationComments(String qualificationCommentsIn)

Parameters:

qualificationCommentsIn - String

getUpdateDate

public Timestamp getUpdateDate()

Returns:

this.updateDate Timestamp

setUpdateDate

public void setUpdateDate(Timestamp updateDateIn)

Parameters:

updateDateIn - Timestamp

getParentDeclaredDocumentReference

public DeclaredDocumentReference getParentDeclaredDocumentReference()

Référence du document déclaratif parent. Utile dans SACAPT. Cela sert à regrouper les marées par fiche de peche.

Returns:

this.parentDeclaredDocumentReference DeclaredDocumentReference

setParentDeclaredDocumentReference

public void setParentDeclaredDocumentReference(DeclaredDocumentReference parentDeclaredDocumentReferenceIn)

Référence du document déclaratif parent. Utile dans SACAPT. Cela sert à regrouper les marées par fiche de peche.

Parameters:

parentDeclaredDocumentReferenceIn - DeclaredDocumentReference

getChildDeclaredDocumentReferences

public Collection<DeclaredDocumentReference> getChildDeclaredDocumentReferences()

Référence du document déclaratif. Utile pour les données issu du log book électronique (flux SACAPT.)

Returns:

this.childDeclaredDocumentReferences Collection

setChildDeclaredDocumentReferences

public void setChildDeclaredDocumentReferences(Collection<DeclaredDocumentReference> childDeclaredDocumentReferencesIn)

Référence du document déclaratif. Utile pour les données issu du log book électronique (flux SACAPT.)

Parameters:

childDeclaredDocumentReferencesIn - Collection

addChildDeclaredDocumentReferences

public boolean addChildDeclaredDocumentReferences(DeclaredDocumentReference elementToAdd)

Référence du document déclaratif. Utile pour les données issu du log book électronique (flux SACAPT.)

Parameters:

elementToAdd - DeclaredDocumentReference

Returns:

true if this collection changed as a result of the call

removeChildDeclaredDocumentReferences

public boolean removeChildDeclaredDocumentReferences(DeclaredDocumentReference elementToRemove)

Référence du document déclaratif. Utile pour les données issu du log book électronique (flux SACAPT.)

Parameters:

elementToRemove - DeclaredDocumentReference

Returns:

true if this collection changed as a result of the call

getSurveyMeasurements

public Collection<SurveyMeasurement> getSurveyMeasurements()

Caractéristiques additionnelles du document déclaratif. Par exemple : Type de document (PSFM+valeurs qualitatives), etc.

Returns:

this.surveyMeasurements Collection

setSurveyMeasurements

public void setSurveyMeasurements(Collection<SurveyMeasurement> surveyMeasurementsIn)

Caractéristiques additionnelles du document déclaratif. Par exemple : Type de document (PSFM+valeurs qualitatives), etc.

Parameters:

surveyMeasurementsIn - Collection

addSurveyMeasurements

public boolean addSurveyMeasurements(SurveyMeasurement elementToAdd)

Caractéristiques additionnelles du document déclaratif. Par exemple : Type de document (PSFM+valeurs qualitatives), etc.

Parameters:

elementToAdd - SurveyMeasurement

Returns:

true if this collection changed as a result of the call

removeSurveyMeasurements

public boolean removeSurveyMeasurements(SurveyMeasurement elementToRemove)

Caractéristiques additionnelles du document déclaratif. Par exemple : Type de document (PSFM+valeurs qualitatives), etc.

Parameters:

elementToRemove - SurveyMeasurement

Returns:

true if this collection changed as a result of the call

getRecorderDepartment

public Department getRecorderDepartment()

Service saisisseur

Returns:

this.recorderDepartment Department

setRecorderDepartment

public void setRecorderDepartment(Department recorderDepartmentIn)

Service saisisseur

Parameters:

recorderDepartmentIn - Department

getRecorderPerson

public Person getRecorderPerson()

Personne liées aux données : utilisateur du système, ou observateurs, responsable de données, etc.

Les personnes liées aux activités professionnelles de pêche sont plutôt gérer dans VesselPerson.

Nombre de lignes : 100

Returns:

this.recorderPerson Person

setRecorderPerson

public void setRecorderPerson(Person recorderPersonIn)

Personne liées aux données : utilisateur du système, ou observateurs, responsable de données, etc.

Les personnes liées aux activités professionnelles de pêche sont plutôt gérer dans VesselPerson.

Nombre de lignes : 100

Parameters:

recorderPersonIn - Person

getProgram

public Program getProgram()

Programme d'observation à l'origine d'une collecte de données. Désigne les activités qui sont à l'origine de la collecte d'un ensemble cohérent de données, que ce soit pour des collectes continues (marées observées en mer, SIPA) ou pour des études limitées dans le temps. La quantité de données rattachées à un programme peut être variable, selon qu'il s'agit d'une activité longue ou intensive, ou d'une opération plus ponctuelle (étude) mais toujours mise en œuvre selon un schéma décidé à l'avance. Exemple de programmes d'observations : - SIH-OBSMER (marées observées en mer) - SIH-STATPECHE (enquete d'activité et d'effort...) - SIPA : données déclaratives transmises par la DPMA - VMS : données satellitaires - OFIMER : données du SI de l'OFIMER

Returns:

this.program Program

setProgram

public void setProgram(Program programIn)

Programme d'observation à l'origine d'une collecte de données. Désigne les activités qui sont à l'origine de la collecte d'un ensemble cohérent de données, que ce soit pour des collectes continues (marées observées en mer, SIPA) ou pour des études limitées dans le temps. La quantité de données rattachées à un programme peut être variable, selon qu'il s'agit d'une activité longue ou intensive, ou d'une opération plus ponctuelle (étude) mais toujours mise en œuvre selon un schéma décidé à l'avance. Exemple de programmes d'observations : - SIH-OBSMER (marées observées en mer) - SIH-STATPECHE (enquete d'activité et d'effort...) - SIPA : données déclaratives transmises par la DPMA - VMS : données satellitaires - OFIMER : données du SI de l'OFIMER

Parameters:

programIn - Program

getVessel

public Vessel getVessel()

Navire, ou plus généralement un usager de la ressource. Peut etre un navire de peche professionnel ou non, un navire scientifique, un pêcheur à pied, un groupement de navires, etc.

Returns:

this.vessel Vessel

setVessel

public void setVessel(Vessel vesselIn)

Navire, ou plus généralement un usager de la ressource. Peut etre un navire de peche professionnel ou non, un navire scientifique, un pêcheur à pied, un groupement de navires, etc.

Parameters:

vesselIn - Vessel

getQualityFlag

public QualityFlag getQualityFlag()

Niveau de qualité de la donnée. "Non qualifiée" par défaut

Returns:

this.qualityFlag QualityFlag

setQualityFlag

public void setQualityFlag(QualityFlag qualityFlagIn)

Niveau de qualité de la donnée. "Non qualifiée" par défaut

Parameters:

qualityFlagIn - QualityFlag

getSales

public Collection<Sale> getSales()

Ventes déclarées

Returns:

this.sales Collection

setSales

public void setSales(Collection<Sale> salesIn)

Ventes déclarées

Parameters:

salesIn - Collection

addSales

public boolean addSales(Sale elementToAdd)

Ventes déclarées

Parameters:

elementToAdd - Sale

Returns:

true if this collection changed as a result of the call

removeSales

public boolean removeSales(Sale elementToRemove)

Ventes déclarées

Parameters:

elementToRemove - Sale

Returns:

true if this collection changed as a result of the call

getFishingTrips

public Collection<FishingTrip> getFishingTrips()

Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.) Un voyage peut représenter type de données : - Une marée observée (en mer, au débarquement), qui désigne une marée de pêche professionnelle au cours de laquelle des relevés sont effectués par un observateur. - Une marée déclarée. Principalement issue du log book électronique (flux SACAPT). Une marée déclarée peut etre un ensemble de marée ou de sous-ensembles de marée (Exemple de la fiche de peche) - une sortie effectuée lors d"une campagne scientifique

Returns:

this.fishingTrips Collection

setFishingTrips

public void setFishingTrips(Collection<FishingTrip> fishingTripsIn)

Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.) Un voyage peut représenter type de données : - Une marée observée (en mer, au débarquement), qui désigne une marée de pêche professionnelle au cours de laquelle des relevés sont effectués par un observateur. - Une marée déclarée. Principalement issue du log book électronique (flux SACAPT). Une marée déclarée peut etre un ensemble de marée ou de sous-ensembles de marée (Exemple de la fiche de peche) - une sortie effectuée lors d"une campagne scientifique

Parameters:

fishingTripsIn - Collection

addFishingTrips

public boolean addFishingTrips(FishingTrip elementToAdd)

Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.) Un voyage peut représenter type de données : - Une marée observée (en mer, au débarquement), qui désigne une marée de pêche professionnelle au cours de laquelle des relevés sont effectués par un observateur. - Une marée déclarée. Principalement issue du log book électronique (flux SACAPT). Une marée déclarée peut etre un ensemble de marée ou de sous-ensembles de marée (Exemple de la fiche de peche) - une sortie effectuée lors d"une campagne scientifique

Parameters:

elementToAdd - FishingTrip

Returns:

true if this collection changed as a result of the call

removeFishingTrips

public boolean removeFishingTrips(FishingTrip elementToRemove)

Voyage en mer, ayant pour vocation une activité de peche (peut etre une campagnes halieutique ou une marée d'un navire professionnel, etc.) Un voyage peut représenter type de données : - Une marée observée (en mer, au débarquement), qui désigne une marée de pêche professionnelle au cours de laquelle des relevés sont effectués par un observateur. - Une marée déclarée. Principalement issue du log book électronique (flux SACAPT). Une marée déclarée peut etre un ensemble de marée ou de sous-ensembles de marée (Exemple de la fiche de peche) - une sortie effectuée lors d"une campagne scientifique

Parameters:

elementToRemove - FishingTrip

Returns:

true if this collection changed as a result of the call

equals

public boolean equals(Object object)

Returns true if the argument is an DeclaredDocumentReference instance and all identifiers for this entity equal the identifiers of the argument entity. Returns false otherwise.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code based on this entity's identifiers.

Overrides:

hashCode in class Object

compareTo

public int compareTo(DeclaredDocumentReference o)

Specified by:

compareTo in interface Comparable<DeclaredDocumentReference>

See Also:

Comparable.compareTo(T)