13.7.1 Propriétés de la classe DocFam
La classe DocFam
hérite de la classe Doc
. Elle dispose, par conséquent, des
propriétés de la classe Doc
.
13.7.1.1 Particularités sur les propriétés héritées
- fromid
- Identifiant de la famille parente.
- icon
- Icone de la famille. Cette icone est aussi utilisée pour les documents de cette famille.
- classname
- Nom de la classe associée à la famille.
- initid
- Identifiant de la famille. Toujours égal à
id
car les familles ne sont pas révisables. - cvid
- Toujours vide. Non utilisable pour une famille.
- dprofid
- Toujours vide. Une famille ne peut pas avoir de profil dynamique.
- revision
- Toujours 0. Les familles ne sont pas révisables.
- state
- Toujours vide. Les familles ne peuvent avoir de cycle de vie.
- wid
- Identifiant du cycle qui sera lié aux nouveaux documents de cette famille.
- title
- Titre de la famille. Ce titre peut faire l'objet d'une traduction.
Le titre localisé est obtenu avec la méthode
DocFam::getTitle()
.
13.7.1.2 Propriétés spécifiques de famille
- schar
-
Indique les modalités de révision des documents de cette famille :
-
R
: Révision automatique à chaque modification, -
S
: document non révisable.
-
- cprofid
- Identifiant du profil qui sera lié aux nouveaux document de la famille.
- dfldid
- Dossier racine de la famille. Ce dossier est notamment utilisé par
l'application
ONEFAM
via l'actionGENERIC:GENERIC_TAB
qui liste les documents. - cfldid
- Identifiant de recherche ou de dossier par défaut. Cet identifiant est
utilisé par l'action
GENERIC:GENERIC_TAB
. Cette recherche est effectuée si aucune autre n'est indiquée en paramètre de cette action. - ccvid
- Identifiant du contrôle de vue qui sera lié aux nouveaux documents de la famille.
- methods
- Liste des fichiers Méthod utilisés pour construire la classe de la famille.
- maxrev
- Nombre de révision maximum pour un document de cette famille.
Si vide ou 0, aucune limite du nombre de révision.
Si le nombre est positif, une fois le nombre de révision maximum atteint,
les révisions les plus anciennes seront supprimées au fur et à mesure des
nouvelles révisions. L'historique ne comportera que les
maxrev
dernières révisions. - defval
- Valeurs par défaut pour les nouveaux documents. Ces valeurs sont linéarisés.
Elles sont accessibles avec la méthode
DocFam::getDefValues()
. - param
- Valeurs des paramètres de la famille. Ces valeurs sont linéarisés.
Elles sont accessibles avec la méthode
DocFam::getParameterRawValue()
ouDoc::getFamilyParameterValue()
.