#
#--
# Copyright (c) 2007-2008, John Mettraux, OpenWFE.org
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are met:
# 
# . Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.  
# 
# . Redistributions in binary form must reproduce the above copyright notice, 
#   this list of conditions and the following disclaimer in the documentation 
#   and/or other materials provided with the distribution.
# 
# . Neither the name of the "OpenWFE" nor the names of its contributors may be
#   used to endorse or promote products derived from this software without
#   specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
# POSSIBILITY OF SUCH DAMAGE.
#++
#
# $Id: utils.rb 3454 2006-10-08 16:51:00Z jmettraux $
#

#
# "made in Japan"
#
# john.mettraux@openwfe.org
#

require 'openwfe/flowexpressionid'


module OpenWFE

    #
    # A few methods about FlowExpressionIds
    #
    module FeiMixin

        protected

            #
            # Makes sure to return a FlowExpressionId instance.
            #
            def extract_fei (object)

                if object.is_a?(FlowExpressionId)

                    object

                elsif object.is_a?(FlowExpression) or 
                    object.is_a?(InFlowItem)

                    object.fei

                elsif object.is_a?(String)

                    FlowExpressionId.to_fei object

                else

                    raise \
                        "cannot extract FlowExpressionId "+
                        "out of #{object.inspect}"
                end
            end

            #
            # A small method for ensuring we have a workflow instance id.
            #
            def extract_wfid (o, parent=false)

                case o
                    #when String then o
                    when FlowExpressionId then o.wfid(parent)
                    when FlowExpression then o.fei.wfid(parent)
                    else o.to_s
                end
            end
    end
    
end