RegulationArea (SIH-Adagio :: Core 3.5.6 API)

Object
- RegulationArea

All Implemented Interfaces:

Serializable, Comparable<RegulationArea>

Direct Known Subclasses:

RegulationAreaImpl
```
public abstract class RegulationArea
extends Object
implements Serializable, Comparable<RegulationArea>
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RegulationArea.Factory
Constructs new instances of RegulationArea.

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

Constructor Summary

Constructors
Constructor and Description

RegulationArea()

Constructors
Constructor and Description
`RegulationArea()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addRegulationLocations(RegulationArea2RegulationLocation elementToAdd)`
`int`	`compareTo(RegulationArea o)`
`boolean`	`equals(Object object)` Returns `true` if the argument is an RegulationArea instance and all identifiers for this entity equal the identifiers of the argument entity.
`DepthGradient`	`getDepthGradient()` Type de gradient de profondeur de la zone de pêche.
`DistanceToCoastGradient`	`getDistanceToCoastGradient()` Distance côte-large de la zone de pêche.
`Fishery`	`getFishery()` Un pecherie, peut etre, si elle n'a pas d'engin, similaire à un stock.
`Grouping`	`getGrouping()` Lien pour pouvoir éventuellement ajouter un lieu d'agrégation.
`Integer`	`getId()` Idenfiant interne.
`Location`	`getLocation()` Représente un lieu au sens général du terme.
`NearbySpecificArea`	`getNearbySpecificArea()` Type de zone de proximité particulière.
`Collection<RegulationArea2RegulationLocation>`	`getRegulationLocations()`
`int`	`hashCode()` Returns a hash code based on this entity's identifiers.
`boolean`	`removeRegulationLocations(RegulationArea2RegulationLocation elementToRemove)`
`void`	`setDepthGradient(DepthGradient depthGradientIn)` Type de gradient de profondeur de la zone de pêche.
`void`	`setDistanceToCoastGradient(DistanceToCoastGradient distanceToCoastGradientIn)` Distance côte-large de la zone de pêche.
`void`	`setFishery(Fishery fisheryIn)` Un pecherie, peut etre, si elle n'a pas d'engin, similaire à un stock.
`void`	`setGrouping(Grouping groupingIn)` Lien pour pouvoir éventuellement ajouter un lieu d'agrégation.
`void`	`setId(Integer idIn)` Idenfiant interne.
`void`	`setLocation(Location locationIn)` Représente un lieu au sens général du terme.
`void`	`setNearbySpecificArea(NearbySpecificArea nearbySpecificAreaIn)` Type de zone de proximité particulière.
`void`	`setRegulationLocations(Collection<RegulationArea2RegulationLocation> regulationLocationsIn)`

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

- Constructor Detail
  - RegulationArea
```
public RegulationArea()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Idenfiant interne. Généré par le système.
    
    Returns:
    this.id Integer
  - setId
```
public void setId(Integer idIn)
```
    Idenfiant interne. Généré par le système.
    
    Parameters:
    idIn - Integer
  - getGrouping
```
public Grouping getGrouping()
```
    Lien pour pouvoir éventuellement ajouter un lieu d'agrégation.
    
    Returns:
    this.grouping Grouping
  - setGrouping
```
public void setGrouping(Grouping groupingIn)
```
    Lien pour pouvoir éventuellement ajouter un lieu d'agrégation.
    
    Parameters:
    groupingIn - Grouping
  - getRegulationLocations
```
public Collection<RegulationArea2RegulationLocation> getRegulationLocations()
```
    Returns:
    this.regulationLocations Collection
  - setRegulationLocations
```
public void setRegulationLocations(Collection<RegulationArea2RegulationLocation> regulationLocationsIn)
```
    Parameters:
    regulationLocationsIn - Collection
  - addRegulationLocations
```
public boolean addRegulationLocations(RegulationArea2RegulationLocation elementToAdd)
```
    Parameters:
    elementToAdd - RegulationArea2RegulationLocation
    
    Returns:
    true if this collection changed as a result of the call
  - removeRegulationLocations
```
public boolean removeRegulationLocations(RegulationArea2RegulationLocation elementToRemove)
```
    Parameters:
    elementToRemove - RegulationArea2RegulationLocation
    
    Returns:
    true if this collection changed as a result of the call
  - getDepthGradient
```
public DepthGradient getDepthGradient()
```
    Type de gradient de profondeur de la zone de pêche.
    
    Returns:
    this.depthGradient DepthGradient
  - setDepthGradient
```
public void setDepthGradient(DepthGradient depthGradientIn)
```
    Type de gradient de profondeur de la zone de pêche.
    
    Parameters:
    depthGradientIn - DepthGradient
  - getLocation
```
public Location getLocation()
```
    Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou surfacique. Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche, un quartier maritime, une criée, etc. Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités : 200
    
    Returns:
    this.location Location
  - setLocation
```
public void setLocation(Location locationIn)
```
    Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou surfacique. Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche, un quartier maritime, une criée, etc. Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités : 200
    
    Parameters:
    locationIn - Location
  - getFishery
```
public Fishery getFishery()
```
    Un pecherie, peut etre, si elle n'a pas d'engin, similaire à un stock.
    
    Définition :
    A unit determined by an authority or other entity that isengaged in raising and/or harvesting fish. Typically, the unit is defined in terms of some or all of the following: people involved, species or type of fish, area of water or seabed, method of fishing, class of boats and purpose of the activities.
    
    Fletcher, W.J., Chesson, J. Fisher, M., Sainsbury K.J., Hundloe, T. Smith A.D.M., and B. Whitworth (2002): National ESD reporting framework for Australian fisheries: The "How To" guide for wild capture fisheries. FRDC Project 2000/145. Canberra, Australia
    
    Returns:
    this.fishery Fishery
  - setFishery
```
public void setFishery(Fishery fisheryIn)
```
    Un pecherie, peut etre, si elle n'a pas d'engin, similaire à un stock.
    
    Définition :
    A unit determined by an authority or other entity that isengaged in raising and/or harvesting fish. Typically, the unit is defined in terms of some or all of the following: people involved, species or type of fish, area of water or seabed, method of fishing, class of boats and purpose of the activities.
    
    Fletcher, W.J., Chesson, J. Fisher, M., Sainsbury K.J., Hundloe, T. Smith A.D.M., and B. Whitworth (2002): National ESD reporting framework for Australian fisheries: The "How To" guide for wild capture fisheries. FRDC Project 2000/145. Canberra, Australia
    
    Parameters:
    fisheryIn - Fishery
  - getNearbySpecificArea
```
public NearbySpecificArea getNearbySpecificArea()
```
    Type de zone de proximité particulière. Par exemple : - DCP (Dispositif de Concentration de Poison) - Filière aquacole - ... (liste non exhaustive) Nombre de lignes : 10
    
    Returns:
    this.nearbySpecificArea NearbySpecificArea
  - setNearbySpecificArea
```
public void setNearbySpecificArea(NearbySpecificArea nearbySpecificAreaIn)
```
    Type de zone de proximité particulière. Par exemple : - DCP (Dispositif de Concentration de Poison) - Filière aquacole - ... (liste non exhaustive) Nombre de lignes : 10
    
    Parameters:
    nearbySpecificAreaIn - NearbySpecificArea
  - getDistanceToCoastGradient
```
public DistanceToCoastGradient getDistanceToCoastGradient()
```
    Distance côte-large de la zone de pêche.
    
    Returns:
    this.distanceToCoastGradient DistanceToCoastGradient
  - setDistanceToCoastGradient
```
public void setDistanceToCoastGradient(DistanceToCoastGradient distanceToCoastGradientIn)
```
    Distance côte-large de la zone de pêche.
    
    Parameters:
    distanceToCoastGradientIn - DistanceToCoastGradient
  - equals
```
public boolean equals(Object object)
```
    Returns true if the argument is an RegulationArea 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(RegulationArea o)
```
    Specified by:
    
    compareTo in interface Comparable<RegulationArea>
    
    See Also:
    Comparable.compareTo(T)

Class RegulationArea

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

RegulationArea

Method Detail

getId

setId

getGrouping

setGrouping

getRegulationLocations

setRegulationLocations

addRegulationLocations

removeRegulationLocations

getDepthGradient

setDepthGradient

getLocation

setLocation

getFishery

setFishery

getNearbySpecificArea

setNearbySpecificArea

getDistanceToCoastGradient

setDistanceToCoastGradient

equals

hashCode

compareTo