Class: Qualification¶

models.document.Qualification

This class is used to create document Qualification, i.e. metadata attributes used to describe the document. The qualifications model is stored in the assets, associating labels to attributes, namely: purpose, sourceCategory, sourceSubCategory and subjects. A qualification can be customized accordingly to rules detailed in the checkValueAttributes method.

Constructors¶

constructor¶

• new Qualification(label, attributes?)

Parameters

Name	Type	Description
`label`	`string`	The qualification label
`attributes`	`QualificationAttributes`	Qualification’s attributes

Defined in

packages/cozy-client/src/models/document/qualification.js:30

Properties¶

icon¶

• icon: string

Defined in

packages/cozy-client/src/models/document/qualification.js:38

label¶

• label: string

Defined in

packages/cozy-client/src/models/document/qualification.js:42

purpose¶

• purpose: string

Defined in

packages/cozy-client/src/models/document/qualification.js:48

sourceCategory¶

• sourceCategory: string

Defined in

packages/cozy-client/src/models/document/qualification.js:56

sourceSubCategory¶

• sourceSubCategory: string

Defined in

packages/cozy-client/src/models/document/qualification.js:64

subjects¶

• subjects: string[]

Defined in

packages/cozy-client/src/models/document/qualification.js:71

Methods¶

checkAttributes¶

▸ checkAttributes(attributes): void

Check the given qualification attributes respects the following rules:

For the given label, if a purpose, sourceCategory or sourceSubCategory attribute is defined in the model, it must match the given qualification.
If not defined in the model for the label, a custom purpose, sourceCategory or sourceSubCategory value can be defined, if it exist in their respective known values list.
For the given label, if subjects are defined in the model, they must be included in the given qualification.
If extra subjects are set, they should exist in the known values.

Parameters