DeclaredDocumentReference (SIH-Adagio Core 3.3.1-rev-401 API)

java.lang.Object
- fr.ifremer.adagio.core.dao.data.survey.declaration.DeclaredDocumentReference

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DeclaredDocumentReferenceImpl
```
public abstract class DeclaredDocumentReference
extends Object
implements Serializable
```
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.

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

Constructor Summary

Constructors
Constructor and Description

DeclaredDocumentReference()

Constructors
Constructor and Description
`DeclaredDocumentReference()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)` This entity does not have any identifiers and is not extending any other entity, so this method will only return `true` if the argument reference and `this` refer to the same object.
`Collection<DeclaredDocumentReference>`	`getChildDeclaredDocumentReferences()`
`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()`
`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()`
`String`	`getQualificationComments()`
`Date`	`getQualificationDate()`
`QualityFlag`	`getQualityFlag()` Niveau de qualité de la donnée.
`Department`	`getRecorderDepartment()` Service saisisseur
`Person`	`getRecorderPerson()`
`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.
`String`	`getSynchronizationStatus()` Etat de synchronisation (en cours, terminé, en attente de synchro, supprimé).
`Timestamp`	`getUpdateDate()`
`Date`	`getValidationDate()`
`Vessel`	`getVessel()`
`int`	`hashCode()` Returns a hash code based on this entity's identifiers.
`void`	`setChildDeclaredDocumentReferences(Collection<DeclaredDocumentReference> childDeclaredDocumentReferences)`
`void`	`setComments(String comments)`
`void`	`setControlDate(Date controlDate)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setDocumentDate(Date documentDate)`
`void`	`setFileName(String fileName)`
`void`	`setFirstSheetNumber(String firstSheetNumber)`
`void`	`setFishingTrips(Collection<FishingTrip> fishingTrips)`
`void`	`setId(Integer id)`
`void`	`setLastSheetNumber(String lastSheetNumber)`
`void`	`setOtherDocumentReference(String otherDocumentReference)`
`void`	`setParentDeclaredDocumentReference(DeclaredDocumentReference parentDeclaredDocumentReference)`
`void`	`setProgram(Program program)`
`void`	`setQualificationComments(String qualificationComments)`
`void`	`setQualificationDate(Date qualificationDate)`
`void`	`setQualityFlag(QualityFlag qualityFlag)`
`void`	`setRecorderDepartment(Department recorderDepartment)`
`void`	`setRecorderPerson(Person recorderPerson)`
`void`	`setReference(String reference)`
`void`	`setSales(Collection<Sale> sales)`
`void`	`setSheetCount(Short sheetCount)`
`void`	`setSurveyMeasurements(Collection<SurveyMeasurement> surveyMeasurements)`
`void`	`setSynchronizationStatus(String synchronizationStatus)`
`void`	`setUpdateDate(Timestamp updateDate)`
`void`	`setValidationDate(Date validationDate)`
`void`	`setVessel(Vessel vessel)`

Methods inherited from class java.lang.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.
  - setId
```
public void setId(Integer id)
```
  - getSynchronizationStatus
```
public String getSynchronizationStatus()
```
    Etat de synchronisation (en cours, terminé, en attente de synchro, supprimé). Seulement visible dans la base locale.
  - setSynchronizationStatus
```
public void setSynchronizationStatus(String synchronizationStatus)
```
  - 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.
  - setReference
```
public void setReference(String reference)
```
  - 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
  - setFileName
```
public void setFileName(String fileName)
```
  - getDocumentDate
```
public Date getDocumentDate()
```
  - setDocumentDate
```
public void setDocumentDate(Date documentDate)
```
  - 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
  - setOtherDocumentReference
```
public void setOtherDocumentReference(String otherDocumentReference)
```
  - 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).
  - setFirstSheetNumber
```
public void setFirstSheetNumber(String firstSheetNumber)
```
  - 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).
  - setLastSheetNumber
```
public void setLastSheetNumber(String lastSheetNumber)
```
  - getSheetCount
```
public Short getSheetCount()
```
    Nombre de feuillets dans la déclaration. Utilisé dans SACROIS/SIPA
  - setSheetCount
```
public void setSheetCount(Short sheetCount)
```
  - getComments
```
public String getComments()
```
    Commentaire.
  - setComments
```
public void setComments(String comments)
```
  - getCreationDate
```
public Date getCreationDate()
```
    Date de création de l'enquete dans le système central.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
  - getControlDate
```
public Date getControlDate()
```
  - setControlDate
```
public void setControlDate(Date controlDate)
```
  - getValidationDate
```
public Date getValidationDate()
```
  - setValidationDate
```
public void setValidationDate(Date validationDate)
```
  - getQualificationDate
```
public Date getQualificationDate()
```
  - setQualificationDate
```
public void setQualificationDate(Date qualificationDate)
```
  - getQualificationComments
```
public String getQualificationComments()
```
  - setQualificationComments
```
public void setQualificationComments(String qualificationComments)
```
  - getUpdateDate
```
public Timestamp getUpdateDate()
```
  - setUpdateDate
```
public void setUpdateDate(Timestamp updateDate)
```
  - getRecorderDepartment
```
public Department getRecorderDepartment()
```
    Service saisisseur
  - setRecorderDepartment
```
public void setRecorderDepartment(Department recorderDepartment)
```
  - getRecorderPerson
```
public Person getRecorderPerson()
```
  - setRecorderPerson
```
public void setRecorderPerson(Person recorderPerson)
```
  - getVessel
```
public Vessel getVessel()
```
  - setVessel
```
public void setVessel(Vessel vessel)
```
  - getQualityFlag
```
public QualityFlag getQualityFlag()
```
    Niveau de qualité de la donnée.
    
    "Non qualifiée" par défaut
  - setQualityFlag
```
public void setQualityFlag(QualityFlag qualityFlag)
```
  - getProgram
```
public Program getProgram()
```
  - setProgram
```
public void setProgram(Program program)
```
  - getChildDeclaredDocumentReferences
```
public Collection<DeclaredDocumentReference> getChildDeclaredDocumentReferences()
```
  - setChildDeclaredDocumentReferences
```
public void setChildDeclaredDocumentReferences(Collection<DeclaredDocumentReference> childDeclaredDocumentReferences)
```
  - 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.
  - setParentDeclaredDocumentReference
```
public void setParentDeclaredDocumentReference(DeclaredDocumentReference parentDeclaredDocumentReference)
```
  - getSales
```
public Collection<Sale> getSales()
```
    Ventes déclarées
  - setSales
```
public void setSales(Collection<Sale> sales)
```
  - getFishingTrips
```
public Collection<FishingTrip> getFishingTrips()
```
  - setFishingTrips
```
public void setFishingTrips(Collection<FishingTrip> fishingTrips)
```
  - getSurveyMeasurements
```
public Collection<SurveyMeasurement> getSurveyMeasurements()
```
    Caractéristiques additionnelles du document déclaratif.
    
    Par exemple : Type de document (PSFM+valeurs qualitatives), etc.
  - setSurveyMeasurements
```
public void setSurveyMeasurements(Collection<SurveyMeasurement> surveyMeasurements)
```
  - equals
```
public boolean equals(Object object)
```
    This entity does not have any identifiers and is not extending any other entity, so this method will only return true if the argument reference and this refer to the same object.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Returns a hash code based on this entity's identifiers.
    
    Overrides:
    
    hashCode in class Object

Class DeclaredDocumentReference

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeclaredDocumentReference

Method Detail

getId

setId

getSynchronizationStatus

setSynchronizationStatus

getReference

setReference

getFileName

setFileName

getDocumentDate

setDocumentDate

getOtherDocumentReference

setOtherDocumentReference

getFirstSheetNumber

setFirstSheetNumber

getLastSheetNumber

setLastSheetNumber

getSheetCount

setSheetCount

getComments

setComments

getCreationDate

setCreationDate

getControlDate

setControlDate

getValidationDate

setValidationDate

getQualificationDate

setQualificationDate

getQualificationComments

setQualificationComments

getUpdateDate

setUpdateDate

getRecorderDepartment

setRecorderDepartment

getRecorderPerson

setRecorderPerson

getVessel

setVessel

getQualityFlag

setQualityFlag

getProgram

setProgram

getChildDeclaredDocumentReferences

setChildDeclaredDocumentReferences

getParentDeclaredDocumentReference

setParentDeclaredDocumentReference

getSales

setSales

getFishingTrips

setFishingTrips

getSurveyMeasurements

setSurveyMeasurements

equals

hashCode