Parameter
Parameter
Description
L'entitĂ© Parameter permet de lister les paramĂštres associĂ©s au nĆud OfferNode. Peut concerner des options ou des composants.
Relations
Ascendantes
Entité | Propriété |
|---|---|
OfferNode | parameters |
Descendantes
Entité | Propriété |
|---|---|
History | history |
Propriétés
Nom | Type | Description | Validateur | Lecture seule ? | Dépréciée ? | DerniÚre version modifiée |
|---|---|---|---|---|---|---|
description | String | Description fonctionnelle du paramĂštre | ï»ż | ï»ż | ï»ż | 3.1.0 |
isArray | Boolean | Indique si une ou plusieurs valeurs sont attendues | ï»ż | ï»ż | ï»ż | 3.1.0 |
options | String[] | Valeurs possibles du paramĂštre pour une liste dĂ©roulante. | ï»ż | ï»ż | ï»ż | 3.1.0 |
type | ParameterTypeEnum | Type de paramĂštre | ï»ż | ï»ż | ï»ż | 3.1.0 |
values | String[] | Valeurs du paramĂštre | ï»ż | ï»ż | ï»ż | 3.1.0 |
id | String | Identifiant de l'entitĂ© Parameter | ï»ż | X | ï»ż | ï»ż |
code | String | Codification fonctionnelle de l'entitĂ© Parameter | ï»ż | ï»ż | ï»ż | ï»ż |
externalId | String | Identifiant de l'entitĂ© Parameter dans le systĂšme client | ï»ż | ï»ż | ï»ż | ï»ż |
externalCode | String | Codification fonctionnelle de l'entitĂ© Parameter dans le systĂšme client | ï»ż | ï»ż | ï»ż | ï»ż |
parameterId | String | Identifiant public de l'entitĂ© Parameter dans l'OIP | ï»ż | ï»ż | ï»ż | ï»ż |
label | String | Information relative au nom de l'entitĂ© Parameter dans son contexte d'utilisation | ï»ż | ï»ż | ï»ż | ï»ż |
createdAt | Date | Date de crĂ©ation de l'entitĂ© Parameter | ï»ż | X | ï»ż | ï»ż |
updatedAt | Date | Date de modification de l'entitĂ© Parameter | ï»ż | X | ï»ż | ï»ż |
Enumérations
ParameterTypeEnum
- BOOLEAN
- NUMBER
- STRING
- DATE
- URI
Enumérations génériques
Aucune enumération générique.
Exemple
import { Entities } from '@fasstech/oip-core';
import { getCompanyId } from '@fasstech/oip-core/entities/Company';
import { getOfferNodeId } from '@fasstech/oip-core/entities/OfferNode';
import { getParameterCode, getParameterDescription, getParameterExternalCode, getParameterExternalId, getParameterId, getParameterIsArray, getParameterLabel, getParameterOptions, getParameterParameterId, getParameterType, getParameterValues, setParameterCode, setParameterDescription, setParameterExternalCode, setParameterExternalId, setParameterIsArray, setParameterLabel, setParameterOptions, setParameterParameterId, setParameterType, setParameterValues } from '@fasstech/oip-core/entities/Parameter';
import { ParameterTypeEnum } from '@fasstech/oip-core/entities/Parameter/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';
(async () => {
let project = await Entities('Project').create();
let company = await Entities('Company').create();
let offerNode = await Entities('OfferNode').create();
const parameter = await Entities('Parameter').create();
setParameterDescription('description', parameter);
setParameterIsArray(false, parameter);
setParameterOptions(['options'], parameter);
setParameterType(ParameterTypeEnum.DATE, parameter);
setParameterValues(['values'], parameter);
setParameterCode('code', parameter);
setParameterExternalId('externalId', parameter);
setParameterExternalCode('externalCode', parameter);
setParameterParameterId('parameterId', parameter);
setParameterLabel('label', parameter);
offerNode = await Entities('Parameter').save(offerNode, parameter);
company = await Entities('OfferNode').save(company, offerNode);
project = await Entities('Company').save(project, company);
await Entities('Project').save(project);
const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
const companyToTest = await Entities('Company').get(projectToTest, { filter: ({ id }) => id === getCompanyId(company) });
const offerNodeToTest = await Entities('OfferNode').get(companyToTest, { filter: ({ id }) => id === getOfferNodeId(offerNode) });
const parameterToTest = await Entities('Parameter').get(offerNodeToTest, { filter: ({ id }) => id === getParameterId(parameter) });
getParameterDescription(parameterToTest); // 'description'
getParameterIsArray(parameterToTest); // false
getParameterOptions(parameterToTest); // ['options']
getParameterType(parameterToTest); // ParameterTypeEnum.DATE
getParameterValues(parameterToTest); // ['values']
getParameterCode(parameterToTest); // 'code'
getParameterExternalId(parameterToTest); // 'externalId'
getParameterExternalCode(parameterToTest); // 'externalCode'
getParameterParameterId(parameterToTest); // 'parameterId'
getParameterLabel(parameterToTest); // 'label'
})();