class Comet::SearchClause

SearchClause is a typed class wrapper around the underlying Comet Server API data structure.

def clear

def clear
  @clause_type = ''
  @rule_field = ''
  @rule_operator = ''
  @rule_value = ''
  @clause_children = []
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
  obj.each do |k, v|
    case k
    when 'ClauseType'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @clause_type = v
    when 'RuleField'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @rule_field = v
    when 'RuleOperator'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @rule_operator = v
    when 'RuleValue'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @rule_value = v
    when 'ClauseChildren'
      if v.nil?
        @clause_children = []
      else
        @clause_children = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @clause_children[i1] = Comet::SearchClause.new
          @clause_children[i1].from_hash(v1)
        end
      end
    else
      @unknown_json_fields[k] = v
    end
  end
end

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
  from_hash(JSON.parse(json_string))
end

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_hash
  ret = {}
  ret['ClauseType'] = @clause_type
  ret['RuleField'] = @rule_field
  ret['RuleOperator'] = @rule_operator
  ret['RuleValue'] = @rule_value
  unless @clause_children.nil?
    ret['ClauseChildren'] = @clause_children
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end