ReferenceDocument (SIH-Adagio

Object
- ReferenceDocument

All Implemented Interfaces:

Serializable, Comparable<ReferenceDocument>

Direct Known Subclasses:

ReferenceDocumentImpl
```
public abstract class ReferenceDocument
extends Object
implements Serializable, Comparable<ReferenceDocument>
```
Les documents de référence sont tous les documents qui peuvent apporter des informations relatives à la classification systématique des taxons (nomenclature, description, synonymie) ou à la définition des groupes de taxons. Ces documents peuvent être des publications officielles (articles de revues ou ouvrage), ou bien des notes de laboratoire, rapports internes, etc. Dans le cas des publications, la référence du document permet de retrouver les sources. En revanche, pour les notes de labo, documents internes, et autres, il faudra préciser dans la référence la localisation de la source (quel service ou quel labo, quelle personne de référence pour se le procurer). Les références des publications doivent respecter les règles d'édition des bibliographies (Auteurs, date. Titre. Editeur...).

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ReferenceDocument.Factory
Constructs new instances of ReferenceDocument.

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

Constructor Summary

Constructors
Constructor and Description

ReferenceDocument()

Constructors
Constructor and Description
`ReferenceDocument()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addAuthors(Author elementToAdd)` Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
`boolean`	`addTaxonInformationHistories(TaxonInformationHistory elementToAdd)`
`int`	`compareTo(ReferenceDocument o)`
`boolean`	`equals(Object object)` Returns `true` if the argument is an ReferenceDocument instance and all identifiers for this entity equal the identifiers of the argument entity.
`Collection<Author>`	`getAuthors()` Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
`String`	`getComments()` Commentaires divers associés au document de référence.
`Date`	`getCreationDate()` Date de création système du document de référence.
`Integer`	`getId()` Identifiant unique du document.
`Date`	`getPublicationDate()` Date de parution du document.
`String`	`getReference()` Libellé stockant la référence du document.
`Status`	`getStatus()` Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire
`Collection<TaxonInformationHistory>`	`getTaxonInformationHistories()`
`Timestamp`	`getUpdateDate()` Date de mise à jour système de la référence.
`int`	`hashCode()` Returns a hash code based on this entity's identifiers.
`boolean`	`removeAuthors(Author elementToRemove)` Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
`boolean`	`removeTaxonInformationHistories(TaxonInformationHistory elementToRemove)`
`void`	`setAuthors(Collection<Author> authorsIn)` Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
`void`	`setComments(String commentsIn)` Commentaires divers associés au document de référence.
`void`	`setCreationDate(Date creationDateIn)` Date de création système du document de référence.
`void`	`setId(Integer idIn)` Identifiant unique du document.
`void`	`setPublicationDate(Date publicationDateIn)` Date de parution du document.
`void`	`setReference(String referenceIn)` Libellé stockant la référence du document.
`void`	`setStatus(Status statusIn)` Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire
`void`	`setTaxonInformationHistories(Collection<TaxonInformationHistory> taxonInformationHistoriesIn)`
`void`	`setUpdateDate(Timestamp updateDateIn)` Date de mise à jour système de la référence.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReferenceDocument
```
public ReferenceDocument()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Identifiant unique du document. Généré par le système.
    
    Returns:
    this.id Integer
  - setId
```
public void setId(Integer idIn)
```
    Identifiant unique du document. Généré par le système.
    
    Parameters:
    idIn - Integer
  - getReference
```
public String getReference()
```
    Libellé stockant la référence du document. Ceci peut être le nom, l'édition etc.
    
    Returns:
    this.reference String
  - setReference
```
public void setReference(String referenceIn)
```
    Libellé stockant la référence du document. Ceci peut être le nom, l'édition etc.
    
    Parameters:
    referenceIn - String
  - getPublicationDate
```
public Date getPublicationDate()
```
    Date de parution du document.
    
    Returns:
    this.publicationDate Date
  - setPublicationDate
```
public void setPublicationDate(Date publicationDateIn)
```
    Date de parution du document.
    
    Parameters:
    publicationDateIn - Date
  - getComments
```
public String getComments()
```
    Commentaires divers associés au document de référence.
    
    Returns:
    this.comments String
  - setComments
```
public void setComments(String commentsIn)
```
    Commentaires divers associés au document de référence.
    
    Parameters:
    commentsIn - String
  - getCreationDate
```
public Date getCreationDate()
```
    Date de création système du document de référence. Renseigné automatiquement par le système.
    
    Returns:
    this.creationDate Date
  - setCreationDate
```
public void setCreationDate(Date creationDateIn)
```
    Date de création système du document de référence. Renseigné automatiquement par le système.
    
    Parameters:
    creationDateIn - Date
  - getUpdateDate
```
public Timestamp getUpdateDate()
```
    Date de mise à jour système de la référence. Renseigné automatiquement par le système.
    
    Returns:
    this.updateDate Timestamp
  - setUpdateDate
```
public void setUpdateDate(Timestamp updateDateIn)
```
    Date de mise à jour système de la référence. Renseigné automatiquement par le système.
    
    Parameters:
    updateDateIn - Timestamp
  - getAuthors
```
public Collection<Author> getAuthors()
```
    Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
    
    Returns:
    this.authors Collection
  - setAuthors
```
public void setAuthors(Collection<Author> authorsIn)
```
    Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
    
    Parameters:
    authorsIn - Collection
  - addAuthors
```
public boolean addAuthors(Author elementToAdd)
```
    Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
    
    Parameters:
    elementToAdd - Author
    
    Returns:
    true if this collection changed as a result of the call
  - removeAuthors
```
public boolean removeAuthors(Author elementToRemove)
```
    Sont considérés comme auteurs les scientifiques qui sont à l'origine de la description (et par là même de la nomenclature et de la position systématique) des taxons, quel que soit leur niveau (famille, genre, espèce ...).
    
    Parameters:
    elementToRemove - Author
    
    Returns:
    true if this collection changed as a result of the call
  - getTaxonInformationHistories
```
public Collection<TaxonInformationHistory> getTaxonInformationHistories()
```
    Returns:
    this.taxonInformationHistories Collection
  - setTaxonInformationHistories
```
public void setTaxonInformationHistories(Collection<TaxonInformationHistory> taxonInformationHistoriesIn)
```
    Parameters:
    taxonInformationHistoriesIn - Collection
  - addTaxonInformationHistories
```
public boolean addTaxonInformationHistories(TaxonInformationHistory elementToAdd)
```
    Parameters:
    elementToAdd - TaxonInformationHistory
    
    Returns:
    true if this collection changed as a result of the call
  - removeTaxonInformationHistories
```
public boolean removeTaxonInformationHistories(TaxonInformationHistory elementToRemove)
```
    Parameters:
    elementToRemove - TaxonInformationHistory
    
    Returns:
    true if this collection changed as a result of the call
  - getStatus
```
public Status getStatus()
```
    Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire. - obsolète (=inactif) : '0' - valide (=actif) : '1' - temporaire : '2' - en cours de suppression : '3' - : '4' note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas confondre avec par exemple l'activité d'un navire sur un mois.
    
    Returns:
    this.status Status
  - setStatus
```
public void setStatus(Status statusIn)
```
    Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire. - obsolète (=inactif) : '0' - valide (=actif) : '1' - temporaire : '2' - en cours de suppression : '3' - : '4' note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas confondre avec par exemple l'activité d'un navire sur un mois.
    
    Parameters:
    statusIn - Status
  - equals
```
public boolean equals(Object object)
```
    Returns true if the argument is an ReferenceDocument 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(ReferenceDocument o)
```
    Specified by:
    
    compareTo in interface Comparable<ReferenceDocument>
    
    See Also:
    Comparable.compareTo(T)

Class ReferenceDocument

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

ReferenceDocument

Method Detail

getId

setId

getReference

setReference

getPublicationDate

setPublicationDate

getComments

setComments

getCreationDate

setCreationDate

getUpdateDate

setUpdateDate

getAuthors

setAuthors

addAuthors

removeAuthors

getTaxonInformationHistories

setTaxonInformationHistories

addTaxonInformationHistories

removeTaxonInformationHistories

getStatus

setStatus

equals

hashCode

compareTo