<PARAMETER> : Action parameter

Java class : leon.info.misc.LyParameter

ROLE

The use of a parameter is done by setting a value to a parameter previously declared. Therefore, this setting is composed of a parameter name and a value. The name is an alphanumeric string that must match a parameter name already declared. The value can be an alphanumeric string, a reference to an object or a list of references to objects of the data model (class, field, action, filter, sort, chart), or a list of marks (field or action marks). The existence of a parameter can be subject to a condition whose name corresponds to a property defined inside the initialisation file of the application.

ATTRIBUTES

<!ATTLIST PARAMETER
	  name CDATA #REQUIRED
	  value CDATA #IMPLIED
	  idref IDREF #IMPLIED
	  condition CDATA #IMPLIED>
Attribute Mand. Description Default
name yes Name of the parameter  
value no Value of the parameter. This parameter is used when the value is encoded as a string.  
idref no Reference of an element in the model. This identifier must correspond to an existing element which type is the one declared in parameter declaration.  
condition no The value of this attribute enables to control the existence of the paarmeter. This condition refers to a property defined or not inside the ini file of the application. If the property does not exists or equals false or equals 0, this parameter is ignored.  

ELEMENTS

<!ELEMENT PARAMETER 
	  (A_MARKS |
	   F_MARKS |
	   FILTER |
	   SORT |
	   CHART)?>
Element Mand. Mult. Description
A_MARKS yes no List of action marks used as parameter.
F_MARKS yes no List of field marks used as parameter.
FILTER yes no Filter used as parameter.
SORT yes no Sort used as parameter.
CHART yes no Chart used as parameter

SAMPLE

<PARAMETER name="textParam" value="param?tre de type texte"/>

<PARAMETER name="classParam" idref="classId"/>

<PARAMETER name="fieldMarks">
	<F_MARKS set="true"/>
</PARAMETER>

<PARAMETER name="classParam" condition="APP_CLIENT" idref="classId1"/>

<PARAMETER name="classParam" condition="APP_OPERATOR" idref="classId2"/>