lib/openwfe/expressions/flowexpression.rb in openwferu-0.9.14 vs lib/openwfe/expressions/flowexpression.rb in openwferu-0.9.15

@@ -60,16 +60,57 @@
     # It gathers all the methods for attributes and variable lookup.
     #
     class FlowExpression < ObjectWithMeta
         include Contextual, Logging, OwfeServiceLocator
 
-        attr_accessor \
-            :fei,
-            :parent_id,
-            :environment_id,
-            :attributes,
-            :children,
-            :apply_time 
+        #
+        # The 'flow expression id' the unique identifier within a
+        # workflow instance for this expression instance.
+        #
+        attr_accessor :fei
+
+        #
+        # The 'flow expression id' of the parent expression.
+        # Will yield 'nil' if this expression is the root of its process
+        # instance.
+        #
+        attr_accessor :parent_id
+
+        #
+        # The 'flow expression id' of the environment this expression works
+        # with.
+        #
+        attr_accessor :environment_id
+
+        #
+        # The attributes of the expression, as found in the process definition.
+        #
+        #     <participant ref='toto' timeout='1d10h' />
+        #
+        # The attributes will be ref => "toto" and timeout => "1d10h" (yes,
+        # 'attributes' contains a hash.
+        #
+        attr_accessor :attributes
+
+        #
+        # An array of 'flow expression id' instances. These are the ids of
+        # the expressions children to this one.
+        #
+        #     <sequence>
+        #         <participant ref="toto" />
+        #         <participant ref="bert" />
+        #     </sequence>
+        #
+        # The expression instance for 'sequence' will hold the feis of toto and
+        # bert in its children array.
+        #
+        attr_accessor :children
+
+        #
+        # When the FlowExpression instance is applied, this time stamp is set
+        # to the current date.
+        #
+        attr_accessor :apply_time 
 
 
         def initialize (fei, parent_id, env_id, app_context, attributes)
 
             super()