Difference between revisions of "GVBufferCondition"

From GreenVulcano Wiki
Jump to: navigation, search
(Created page with "==Description== This element allows you to specify the conditions that the fields buffer GVBuffer must meet. =={{VULCON}} / {{GVCONSOLE}} Configuration== A GVBufferCondition l...")
 
(Property)
 
(4 intermediate revisions by the same user not shown)
Line 18: Line 18:
 
|-
 
|-
 
| throw-exception || optional || If true an error during execution cause an Exception to be thrown.
 
| throw-exception || optional || If true an error during execution cause an Exception to be thrown.
If false an error during execution cause the condition to return "false". Default to "false".
+
If false an error during execution cause the condition to return "false". Default to "false". <br/>
 
The attribute's admitted values are:
 
The attribute's admitted values are:
 
* true
 
* true
Line 30: Line 30:
 
Its subelements are:
 
Its subelements are:
 
* Description
 
* Description
* [[RetCodeField]]
+
* [[GVBufferCondition#RetCodeField|RetCodeField]]
* [[Property]] or [[PropertyCompare]]
+
* [[GVBufferCondition#Property|Property]] or [[GVBufferCondition#PropertyCompare|PropertyCompare]]
 +
 
 +
===RetCodeField===
 +
 
 +
This element verifies that the return code is in a certain range of values.
 +
You can specify multiple ranges. The condition is verified if the return code is at least in one
 +
of configured ranges.
 +
 
 +
The following table shows the RetCodeField element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''gvbuffer-field'''.
 +
|-
 +
| name || fixed || Defines the name of field '''return code'''. This attribute must assume the value '''RetCodeField'''.
 +
|}
 +
 
 +
Its subelements are:
 +
* [[Description]]
 +
* [[#RangeDef|RangeDef]]
 +
 
 +
====RangeDef====
 +
 
 +
This element specifies a range of values.
 +
 
 +
The following table show the element's attributes RangeDef:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| min || optional || This attribute defines the minimum value of the range.
 +
If not specified, assumes 'the minimum allowable value'.
 +
|-
 +
| max || optional || This attribute defines the maximum value of the range.
 +
If not specified, assumes 'the maximum allowable value'.
 +
|}
 +
 
 +
===Property===
 +
 
 +
This element verifies that a property takes a certain value.
 +
 
 +
The attribute 'value' and the elements RangeDef can not be defined together. If the attribute 'value' and the RangeDef elements are not specified is only tested for the presence of the property.
 +
 
 +
The following table shows the Property element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''gvbuffer-field'''.
 +
|-
 +
| name || required || This attribute defines the name of the property to check.
 +
|-
 +
| value-type || optional || This attribute defines the type of expected value. The attribute's admitted values are:
 +
* text
 +
* integer
 +
|-
 +
| value || optional || This attribute defines the expected value.
 +
|-
 +
| operator || optional || This attribute defines the type of operator to use. The attribute's admitted values are:
 +
* equal
 +
* lesser
 +
* lesser-equal
 +
* greater
 +
* greater-equal
 +
* different
 +
|-
 +
| group || optional || This attribute defines the set of fields to check in AND.
 +
|}
 +
 
 +
Its sub-elements are:
 +
* [[Description]]
 +
* [[GVBufferCondition#RangeDef|RangeDef]]
 +
 
 +
===PropertyCompare===
 +
 
 +
This element compares the value of two properties.
 +
 
 +
The following table shows the PropertyCompare element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''gvbuffer-field'''.
 +
|-
 +
| name-a || required || This attribute defines the name of the first property to check.
 +
|-
 +
| name-b || required || This attribute defines the name of the second property to check.
 +
|-
 +
| value-type || optional || This attribute defines the type of expected value. The attribute's admitted values are:
 +
* text
 +
* integer
 +
|-
 +
| operator || optional || This attribute defines the type of operator to use. The attribute's admitted values are:
 +
* equal
 +
* lesser
 +
* lesser-equal
 +
* greater
 +
* greater-equal
 +
* different
 +
|-
 +
| group || optional || This attribute defines the set of fields to check in AND.
 +
|}

Latest revision as of 09:08, 10 April 2012

Description

This element allows you to specify the conditions that the fields buffer GVBuffer must meet.

VulCon / GV Console Configuration

A GVBufferCondition lets you specify multiple conditions on individual fields. The conditions are evaluated in AND.

The following table shows the GVBufferCondition element's attributes:

Attribute Type Description
type fixed This attribute must assume the value condition.
class fixed This attribute must assume the value it.greenvulcano.gvesb.internal.condition.GVBufferCondition.
condition required This attribute defines the name of the condition. Unique inside the Conditions element.
throw-exception optional If true an error during execution cause an Exception to be thrown.

If false an error during execution cause the condition to return "false". Default to "false".
The attribute's admitted values are:

  • true
  • false
system optional The attribute verify that the system field contains the configured value.
service optional The attribute verify that the service field contains the configured value.

Its subelements are:

RetCodeField

This element verifies that the return code is in a certain range of values. You can specify multiple ranges. The condition is verified if the return code is at least in one of configured ranges.

The following table shows the RetCodeField element's attributes:

Attribute Type Description
type fixed This attribute must assume the value gvbuffer-field.
name fixed Defines the name of field return code. This attribute must assume the value RetCodeField.

Its subelements are:

RangeDef

This element specifies a range of values.

The following table show the element's attributes RangeDef:

Attribute Type Description
min optional This attribute defines the minimum value of the range.

If not specified, assumes 'the minimum allowable value'.

max optional This attribute defines the maximum value of the range.

If not specified, assumes 'the maximum allowable value'.

Property

This element verifies that a property takes a certain value.

The attribute 'value' and the elements RangeDef can not be defined together. If the attribute 'value' and the RangeDef elements are not specified is only tested for the presence of the property.

The following table shows the Property element's attributes:

Attribute Type Description
type fixed This attribute must assume the value gvbuffer-field.
name required This attribute defines the name of the property to check.
value-type optional This attribute defines the type of expected value. The attribute's admitted values are:
  • text
  • integer
value optional This attribute defines the expected value.
operator optional This attribute defines the type of operator to use. The attribute's admitted values are:
  • equal
  • lesser
  • lesser-equal
  • greater
  • greater-equal
  • different
group optional This attribute defines the set of fields to check in AND.

Its sub-elements are:

PropertyCompare

This element compares the value of two properties.

The following table shows the PropertyCompare element's attributes:

Attribute Type Description
type fixed This attribute must assume the value gvbuffer-field.
name-a required This attribute defines the name of the first property to check.
name-b required This attribute defines the name of the second property to check.
value-type optional This attribute defines the type of expected value. The attribute's admitted values are:
  • text
  • integer
operator optional This attribute defines the type of operator to use. The attribute's admitted values are:
  • equal
  • lesser
  • lesser-equal
  • greater
  • greater-equal
  • different
group optional This attribute defines the set of fields to check in AND.