---
title: CollectionNeed
slug: oip-next/qtarkny1zvp9uptydyfa
createdAt: 2024-02-21T13:40:14.000Z
---

# CollectionNeed

## Description

L'entité CollectionNeed regroupe les données sur la gestion du recueil de besoin par risque et collège.

## Relations

### Ascendantes

| Entité  | Propriété       |
| ------- | --------------- |
| Project | collectionNeeds |

### Descendantes

| Entité         | Propriété       |
| -------------- | --------------- |
| HealthNeed     | healthNeeds     |
| History        | history         |
| PensionNeed    | pensionNeed     |
| ProtectionNeed | protectionNeeds |
| Relation       | relations       |

## Liste des propriétés

| Nom                   | Type                             | Dernière version modifiée | Description                                                                                                         | Getter                                 | Setter                                 | Deprecated |
| --------------------- | -------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -------------------------------------- | ---------- |
| college               | `collectionNeedCollegeEnum`      | 2.2.0                     | Collège                                                                                                             | getCollectionNeedCollege               | setCollectionNeedCollege               | -          |
| createdAt             | `Date`                           |                           | Date de création de l'entité `CollectionNeed`                                                                       | getCollectionNeedCreatedAt             | Lecture seule                          | -          |
| createdBy             | `String`                         |                           | Utilisateur à l'origine de la création de l'entité `CollectionNeed`                                                 | getCollectionNeedCreatedBy             | Lecture seule                          | -          |
| id                    | `String`                         |                           | Identifiant unique de l'entité `CollectionNeed`                                                                     | getCollectionNeedId                    | Lecture seule                          | -          |
| isDutyOfAdviceSkipped | `Boolean`                        | 2.5.0                     | A-t-on dérogé au devoir de conseil ?                                                                                | getCollectionNeedIsDutyOfAdviceSkipped | setCollectionNeedIsDutyOfAdviceSkipped | -          |
| isEnforcedGuarantee   | `Boolean`                        | 2.2.0                     | Si true, alors sélection des garanties renforcées. Si false, alors on est dans les obligations minimales de la CCN. | getCollectionNeedIsEnforcedGuarantee   | setCollectionNeedIsEnforcedGuarantee   | -          |
| riskAndRange          | `collectionNeedRiskAndRangeEnum` | 2.2.0                     | Risque avec la gamme                                                                                                | getCollectionNeedRiskAndRange          | setCollectionNeedRiskAndRange          | -          |
| updatedAt             | `Date`                           |                           | Date de modification de l'entité `CollectionNeed`                                                                   | getCollectionNeedUpdatedAt             | Lecture seule                          | -          |
| updatedBy             | `String`                         |                           | Utilisateur à l'origine de la modification de l'entité `CollectionNeed`                                             | getCollectionNeedUpdatedBy             | Lecture seule                          | -          |

## Enums

### collectionNeedCollegeEnum

- `collectionNeedCollegeEnum.ALL`
- `collectionNeedCollegeEnum.EMPLOYEES`
- `collectionNeedCollegeEnum.EXECUTIVE_EMPLOYEES`

### collectionNeedRiskAndRangeEnum

- `collectionNeedRiskAndRangeEnum.GROUP_CAREER_ENDING`
- `collectionNeedRiskAndRangeEnum.GROUP_HEALTH`
- `collectionNeedRiskAndRangeEnum.GROUP_PROTECTION`
- `collectionNeedRiskAndRangeEnum.GROUP_RETIREMENT_SAVINGS_PLAN`
- `collectionNeedRiskAndRangeEnum.GROUP_SAVINGS_PLAN`
- `collectionNeedRiskAndRangeEnum.GROUP_SEVERANCE_PAY`
- `collectionNeedRiskAndRangeEnum.INDIVIDUAL_HEALTH`
- `collectionNeedRiskAndRangeEnum.INDIVIDUAL_PROTECTION`
- `collectionNeedRiskAndRangeEnum.INDIVIDUAL_RETIREMENT_SAVINGS_PLAN`
- `collectionNeedRiskAndRangeEnum.INDIVIDUAL_SAVINGS_PLAN`
- `collectionNeedRiskAndRangeEnum.MULTI_RISK_BUILDING`
- `collectionNeedRiskAndRangeEnum.MULTI_RISK_HOME`
- `collectionNeedRiskAndRangeEnum.PROFESSIONAL_MULTI_RISK`
- `collectionNeedRiskAndRangeEnum.SALARY_CONTINUATION`
- `collectionNeedRiskAndRangeEnum.SELF_EMPLOYED_WORKER_HEALTH`
- `collectionNeedRiskAndRangeEnum.SELF_EMPLOYED_WORKER_PROTECTION`

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCollectionNeedCollege, getCollectionNeedIsDutyOfAdviceSkipped, getCollectionNeedIsEnforcedGuarantee, getCollectionNeedRiskAndRange, getcollectionNeedId, setCollectionNeedCollege, setCollectionNeedIsDutyOfAdviceSkipped, setCollectionNeedIsEnforcedGuarantee, setCollectionNeedRiskAndRange } from '@fasstech/oip-core/entities/collectionNeed';
import { collectionNeedCollegeEnum, collectionNeedRiskAndRangeEnum } from '@fasstech/oip-core/entities/collectionNeed/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';

(async () => {
  let ProjectEntity = await Entities('Project').get({ id: projectId });
  const CollectionNeedEntity = await Entities('CollectionNeed').create();
  
  setCollectionNeedCollege(collectionNeedCollegeEnum.ALL, CollectionNeedEntity);
  setCollectionNeedIsDutyOfAdviceSkipped(false, CollectionNeedEntity);
  setCollectionNeedIsEnforcedGuarantee(false, CollectionNeedEntity);
  setCollectionNeedRiskAndRange(collectionNeedRiskAndRangeEnum.GROUP_PROTECTION, CollectionNeedEntity);
  
  ProjectEntity = await Entities('CollectionNeed').save(ProjectEntity, CollectionNeedEntity);
  await Entities('Project').save(ProjectEntity);
  
  const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
  const CollectionNeedEntityToTest = await Entities('CollectionNeed').get(ProjectEntityToTest, getCollectionNeedId(CollectionNeedEntity));
  
  getCollectionNeedCollege(CollectionNeedEntityToTest); // collectionNeedCollegeEnum.ALL
  getCollectionNeedIsDutyOfAdviceSkipped(CollectionNeedEntityToTest); // false
  getCollectionNeedIsEnforcedGuarantee(CollectionNeedEntityToTest); // false
  getCollectionNeedRiskAndRange(CollectionNeedEntityToTest); // collectionNeedRiskAndRangeEnum.GROUP_PROTECTION
})();
```
