Parameter (SIH-Adagio :: Core 3.5.6 API)

Object
- Parameter

All Implemented Interfaces:

Serializable, Comparable<Parameter>

Direct Known Subclasses:

ParameterImpl
```
public abstract class Parameter
extends Object
implements Serializable, Comparable<Parameter>
```
Un paramètre est une propriété du milieu ou d'un élément du milieu qui contribue à en apprécier les caractéristiques et/ou la qualité et/ou l'aptitude à des usages. Le paramètre se décline en trois types : quantitatif, qualitatif ou libre. Le type quantitatif se rapporte aux paramètres qui ont une infinité de résultats numériques. Le type qualitatif se rapporte aux paramètres qui ne prennent qu'un nombre limité de valeurs prédéfinies pour chacun d'eux. Le type libre, ou alphanumérique, correspond aux paramètres de valeurs alphanumériques, sans limite de valeurs possibles (hormis la longueur de la chaine : 40 max). Ces trois types sont mutuellement exclusifs. Exemple de paramètre : • Taille (numérique) • Age (numérique) • Sexe (qualitatif) • Catégorie commerciale (qualitatif) • Présentation commerciale (qualitatif) • Vrac / Hors Vrac (qualitatif) • Rejet / Débarquement (qualitatif) (Discard/Landing) • Stade de maturité (qualitatif) (Maturity stage) • Numéro de contrat (libre - alphanumérique) Cette liste n’est pas exhaustive. Nombre de lignes : 130

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Parameter.Factory
Constructs new instances of Parameter.

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

Constructor Summary

Constructors
Constructor and Description

Parameter()

Constructors
Constructor and Description
`Parameter()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addQualitativeValues(QualitativeValue elementToAdd)` Liste des valeurs qualitatives que peut prendre un paramètre.
`int`	`compareTo(Parameter o)`
`boolean`	`equals(Object object)` Returns `true` if the argument is an Parameter instance and all identifiers for this entity equal the identifiers of the argument entity.
`String`	`getCode()` Code du paramètre
`String`	`getComments()`
`Date`	`getCreationDate()`
`String`	`getDescription()` Description du paramètre
`String`	`getName()` Libellé du paramètre
`ParameterGroup`	`getParameterGroup()` Groupe de paramètres.
`Collection<QualitativeValue>`	`getQualitativeValues()` Liste des valeurs qualitatives que peut prendre un paramètre.
`Status`	`getStatus()` état de l'objet (actif ou inactif)
`Timestamp`	`getUpdateDate()`
`int`	`hashCode()` Returns a hash code based on this entity's identifiers.
`Boolean`	`isIsAlphanumeric()` Indique si pour le paramètre on saisit des valeurs alphanumérique (=Vrai) ou si on choisit dans une liste de valeurs qualitatives ou si les valeurs sont numérique (=Faux - cf isQualitative)
`Boolean`	`isIsCalculated()` Indique si le paramètre est calculé
`Boolean`	`isIsQualitative()` Indique si pour le paramètre on saisit des valeurs numérique ou si on choisit dans une liste de valeurs qualitatives
`Boolean`	`isIsTaxinomic()` Indique si le paramètre est utilisé pour des mesures de dénombrement
`boolean`	`removeQualitativeValues(QualitativeValue elementToRemove)` Liste des valeurs qualitatives que peut prendre un paramètre.
`void`	`setCode(String codeIn)` Code du paramètre
`void`	`setComments(String commentsIn)`
`void`	`setCreationDate(Date creationDateIn)`
`void`	`setDescription(String descriptionIn)` Description du paramètre
`void`	`setIsAlphanumeric(Boolean isAlphanumericIn)` Indique si pour le paramètre on saisit des valeurs alphanumérique (=Vrai) ou si on choisit dans une liste de valeurs qualitatives ou si les valeurs sont numérique (=Faux - cf isQualitative)
`void`	`setIsCalculated(Boolean isCalculatedIn)` Indique si le paramètre est calculé
`void`	`setIsQualitative(Boolean isQualitativeIn)` Indique si pour le paramètre on saisit des valeurs numérique ou si on choisit dans une liste de valeurs qualitatives
`void`	`setIsTaxinomic(Boolean isTaxinomicIn)` Indique si le paramètre est utilisé pour des mesures de dénombrement
`void`	`setName(String nameIn)` Libellé du paramètre
`void`	`setParameterGroup(ParameterGroup parameterGroupIn)` Groupe de paramètres.
`void`	`setQualitativeValues(Collection<QualitativeValue> qualitativeValuesIn)` Liste des valeurs qualitatives que peut prendre un paramètre.
`void`	`setStatus(Status statusIn)` état de l'objet (actif ou inactif)
`void`	`setUpdateDate(Timestamp updateDateIn)`

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

- Constructor Detail
  - Parameter
```
public Parameter()
```
- Method Detail
  - getCode
```
public String getCode()
```
    Code du paramètre
    
    Returns:
    this.code String
  - setCode
```
public void setCode(String codeIn)
```
    Code du paramètre
    
    Parameters:
    codeIn - String
  - getName
```
public String getName()
```
    Libellé du paramètre
    
    Returns:
    this.name String
  - setName
```
public void setName(String nameIn)
```
    Libellé du paramètre
    
    Parameters:
    nameIn - String
  - getDescription
```
public String getDescription()
```
    Description du paramètre
    
    Returns:
    this.description String
  - setDescription
```
public void setDescription(String descriptionIn)
```
    Description du paramètre
    
    Parameters:
    descriptionIn - String
  - isIsQualitative
```
public Boolean isIsQualitative()
```
    Indique si pour le paramètre on saisit des valeurs numérique ou si on choisit dans une liste de valeurs qualitatives
    
    Returns:
    this.isQualitative Boolean
  - setIsQualitative
```
public void setIsQualitative(Boolean isQualitativeIn)
```
    Indique si pour le paramètre on saisit des valeurs numérique ou si on choisit dans une liste de valeurs qualitatives
    
    Parameters:
    isQualitativeIn - Boolean
  - isIsTaxinomic
```
public Boolean isIsTaxinomic()
```
    Indique si le paramètre est utilisé pour des mesures de dénombrement
    
    Returns:
    this.isTaxinomic Boolean
  - setIsTaxinomic
```
public void setIsTaxinomic(Boolean isTaxinomicIn)
```
    Indique si le paramètre est utilisé pour des mesures de dénombrement
    
    Parameters:
    isTaxinomicIn - Boolean
  - isIsCalculated
```
public Boolean isIsCalculated()
```
    Indique si le paramètre est calculé
    
    Returns:
    this.isCalculated Boolean
  - setIsCalculated
```
public void setIsCalculated(Boolean isCalculatedIn)
```
    Indique si le paramètre est calculé
    
    Parameters:
    isCalculatedIn - Boolean
  - isIsAlphanumeric
```
public Boolean isIsAlphanumeric()
```
    Indique si pour le paramètre on saisit des valeurs alphanumérique (=Vrai) ou si on choisit dans une liste de valeurs qualitatives ou si les valeurs sont numérique (=Faux - cf isQualitative)
    
    Returns:
    this.isAlphanumeric Boolean
  - setIsAlphanumeric
```
public void setIsAlphanumeric(Boolean isAlphanumericIn)
```
    Indique si pour le paramètre on saisit des valeurs alphanumérique (=Vrai) ou si on choisit dans une liste de valeurs qualitatives ou si les valeurs sont numérique (=Faux - cf isQualitative)
    
    Parameters:
    isAlphanumericIn - Boolean
  - getCreationDate
```
public Date getCreationDate()
```
    Returns:
    this.creationDate Date
  - setCreationDate
```
public void setCreationDate(Date creationDateIn)
```
    Parameters:
    creationDateIn - Date
  - getUpdateDate
```
public Timestamp getUpdateDate()
```
    Returns:
    this.updateDate Timestamp
  - setUpdateDate
```
public void setUpdateDate(Timestamp updateDateIn)
```
    Parameters:
    updateDateIn - Timestamp
  - getComments
```
public String getComments()
```
    Returns:
    this.comments String
  - setComments
```
public void setComments(String commentsIn)
```
    Parameters:
    commentsIn - String
  - getParameterGroup
```
public ParameterGroup getParameterGroup()
```
    Groupe de paramètres. Les groupes permettent le regroupement et la hiérarchisation des paramètres, par thématiques. Par exemple, on aura : - Halieutique |- Individu (paramètres : taille, sexe, ..) |- Engin (paramètres : longueur de bras, ...) |- Condition d'observation (paramètres : état de la mer...)
    
    Returns:
    this.parameterGroup ParameterGroup
  - setParameterGroup
```
public void setParameterGroup(ParameterGroup parameterGroupIn)
```
    Groupe de paramètres. Les groupes permettent le regroupement et la hiérarchisation des paramètres, par thématiques. Par exemple, on aura : - Halieutique |- Individu (paramètres : taille, sexe, ..) |- Engin (paramètres : longueur de bras, ...) |- Condition d'observation (paramètres : état de la mer...)
    
    Parameters:
    parameterGroupIn - ParameterGroup
  - getStatus
```
public Status getStatus()
```
    état de l'objet (actif ou inactif)
    
    Returns:
    this.status Status
  - setStatus
```
public void setStatus(Status statusIn)
```
    état de l'objet (actif ou inactif)
    
    Parameters:
    statusIn - Status
  - getQualitativeValues
```
public Collection<QualitativeValue> getQualitativeValues()
```
    Liste des valeurs qualitatives que peut prendre un paramètre. Par exemple : - pour le paramètre Sexe : "Mâle" et "Femelle" - pour le paramètre Présentation : "Vidé", "Entier", ... - pour le paramètre Catégorie : "Gros", "Moyen", ...
    
    Returns:
    this.qualitativeValues Collection
  - setQualitativeValues
```
public void setQualitativeValues(Collection<QualitativeValue> qualitativeValuesIn)
```
    Liste des valeurs qualitatives que peut prendre un paramètre. Par exemple : - pour le paramètre Sexe : "Mâle" et "Femelle" - pour le paramètre Présentation : "Vidé", "Entier", ... - pour le paramètre Catégorie : "Gros", "Moyen", ...
    
    Parameters:
    qualitativeValuesIn - Collection
  - addQualitativeValues
```
public boolean addQualitativeValues(QualitativeValue elementToAdd)
```
    Liste des valeurs qualitatives que peut prendre un paramètre. Par exemple : - pour le paramètre Sexe : "Mâle" et "Femelle" - pour le paramètre Présentation : "Vidé", "Entier", ... - pour le paramètre Catégorie : "Gros", "Moyen", ...
    
    Parameters:
    elementToAdd - QualitativeValue
    
    Returns:
    true if this collection changed as a result of the call
  - removeQualitativeValues
```
public boolean removeQualitativeValues(QualitativeValue elementToRemove)
```
    Liste des valeurs qualitatives que peut prendre un paramètre. Par exemple : - pour le paramètre Sexe : "Mâle" et "Femelle" - pour le paramètre Présentation : "Vidé", "Entier", ... - pour le paramètre Catégorie : "Gros", "Moyen", ...
    
    Parameters:
    elementToRemove - QualitativeValue
    
    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 Parameter 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(Parameter o)
```
    Specified by:
    
    compareTo in interface Comparable<Parameter>
    
    See Also:
    Comparable.compareTo(T)

Class Parameter

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Parameter

Method Detail

getCode

setCode

getName

setName

getDescription

setDescription

isIsQualitative

setIsQualitative

isIsTaxinomic

setIsTaxinomic

isIsCalculated

setIsCalculated

isIsAlphanumeric

setIsAlphanumeric

getCreationDate

setCreationDate

getUpdateDate

setUpdateDate

getComments

setComments

getParameterGroup

setParameterGroup

getStatus

setStatus

getQualitativeValues

setQualitativeValues

addQualitativeValues

removeQualitativeValues

equals

hashCode

compareTo