Class: Alfresco::RequestDefaults

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco/models/request_defaults.rb

Overview

Common query defaults

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestDefaults

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/alfresco/models/request_defaults.rb', line 78

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'textAttributes')
    if (value = attributes[:'textAttributes']).is_a?(Array)
      self.text_attributes = value
    end
  end

  if attributes.has_key?(:'defaultFTSOperator')
    self.default_fts_operator = attributes[:'defaultFTSOperator']
  else
    self.default_fts_operator = "AND"
  end

  if attributes.has_key?(:'defaultFTSFieldOperator')
    self.default_fts_field_operator = attributes[:'defaultFTSFieldOperator']
  else
    self.default_fts_field_operator = "AND"
  end

  if attributes.has_key?(:'namespace')
    self.namespace = attributes[:'namespace']
  else
    self.namespace = "cm"
  end

  if attributes.has_key?(:'defaultFieldName')
    self.default_field_name = attributes[:'defaultFieldName']
  else
    self.default_field_name = "TEXT"
  end

end

Instance Attribute Details

#default_field_name ⇒ Object

Returns the value of attribute default_field_name.



30
31
32
 
# File 'lib/alfresco/models/request_defaults.rb', line 30

def default_field_name
  @default_field_name
end

#default_fts_field_operator ⇒ Object

The default way to combine query parts in field query groups when AND or OR is not explicitly stated - includes ! - + FIELD:(one two three)



25
26
27
 
# File 'lib/alfresco/models/request_defaults.rb', line 25

def default_fts_field_operator
  @default_fts_field_operator
end

#default_fts_operator ⇒ Object

The default way to combine query parts when AND or OR is not explicitly stated - includes ! - + one two three (one two three)



22
23
24
 
# File 'lib/alfresco/models/request_defaults.rb', line 22

def default_fts_operator
  @default_fts_operator
end

#namespace ⇒ Object

The default name space to use if one is not provided



28
29
30
 
# File 'lib/alfresco/models/request_defaults.rb', line 28

def namespace
  @namespace
end

#text_attributes ⇒ Object

A list of query fields/properties used to expand TEXT: queries. The default is cm:content. You could include all content properties using d:content or list all individual content properties or types. As more terms are included the query size, complexity, memory impact and query time will increase.



19
20
21
 
# File 'lib/alfresco/models/request_defaults.rb', line 19

def text_attributes
  @text_attributes
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



55
56
57
58
59
60
61
62
63
 
# File 'lib/alfresco/models/request_defaults.rb', line 55

def self.attribute_map
  {
    :'text_attributes' => :'textAttributes',
    :'default_fts_operator' => :'defaultFTSOperator',
    :'default_fts_field_operator' => :'defaultFTSFieldOperator',
    :'namespace' => :'namespace',
    :'default_field_name' => :'defaultFieldName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
 
# File 'lib/alfresco/models/request_defaults.rb', line 66

def self.swagger_types
  {
    :'text_attributes' => :'Array<String>',
    :'default_fts_operator' => :'String',
    :'default_fts_field_operator' => :'String',
    :'namespace' => :'String',
    :'default_field_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
 
# File 'lib/alfresco/models/request_defaults.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      text_attributes == o.text_attributes &&
      default_fts_operator == o.default_fts_operator &&
      default_fts_field_operator == o.default_fts_field_operator &&
      namespace == o.namespace &&
      default_field_name == o.default_field_name
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/alfresco/models/request_defaults.rb', line 201

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Alfresco.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/alfresco/models/request_defaults.rb', line 267

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/alfresco/models/request_defaults.rb', line 180

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


167
168
169
 
# File 'lib/alfresco/models/request_defaults.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/alfresco/models/request_defaults.rb', line 173

def hash
  [text_attributes, default_fts_operator, default_fts_field_operator, namespace, default_field_name].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



118
119
120
121
 
# File 'lib/alfresco/models/request_defaults.rb', line 118

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
 
# File 'lib/alfresco/models/request_defaults.rb', line 247

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



253
254
255
256
257
258
259
260
261
 
# File 'lib/alfresco/models/request_defaults.rb', line 253

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



241
242
243
 
# File 'lib/alfresco/models/request_defaults.rb', line 241

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



125
126
127
128
129
130
131
 
# File 'lib/alfresco/models/request_defaults.rb', line 125

def valid?
  default_fts_operator_validator = EnumAttributeValidator.new('String', ["AND", "OR"])
  return false unless default_fts_operator_validator.valid?(@default_fts_operator)
  default_fts_field_operator_validator = EnumAttributeValidator.new('String', ["AND", "OR"])
  return false unless default_fts_field_operator_validator.valid?(@default_fts_field_operator)
  return true
end