Class: AsposeWordsCloud::DocumentEntryList

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/document_entry_list.rb

Overview

Represents a list of documents which will be appended to the original resource document.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentEntryList

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 60

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.key?(:'AppendAllEntriesToOneSection')
    self.append_all_entries_to_one_section = attributes[:'AppendAllEntriesToOneSection']
  end

  if attributes.key?(:'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments')
    self.apply_base_document_headers_and_footers_to_appending_documents = attributes[:'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments']
  end

  if attributes.key?(:'DocumentEntries')
    if (value = attributes[:'DocumentEntries']).is_a?(Array)
      self.document_entries = value
    end
  end
end

Instance Attribute Details

#append_all_entries_to_one_section ⇒ Object

Gets or sets a value indicating whether to append all documents to the same section.



33
34
35
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 33

def append_all_entries_to_one_section
  @append_all_entries_to_one_section
end

#apply_base_document_headers_and_footers_to_appending_documents ⇒ Object

Gets or sets a value indicating whether to apply headers and footers from base document to appending documents. The default value is true.



36
37
38
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 36

def apply_base_document_headers_and_footers_to_appending_documents
  @apply_base_document_headers_and_footers_to_appending_documents
end

#document_entries ⇒ Object

Gets or sets the list of documents.



39
40
41
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 39

def document_entries
  @document_entries
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 41

def self.attribute_map
  {
    :'append_all_entries_to_one_section' => :'AppendAllEntriesToOneSection',
    :'apply_base_document_headers_and_footers_to_appending_documents' => :'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments',
    :'document_entries' => :'DocumentEntries'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 50

def self.swagger_types
  {
    :'append_all_entries_to_one_section' => :'BOOLEAN',
    :'apply_base_document_headers_and_footers_to_appending_documents' => :'BOOLEAN',
    :'document_entries' => :'Array<DocumentEntry>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
94
95
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 89

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      append_all_entries_to_one_section == other.append_all_entries_to_one_section &&
      apply_base_document_headers_and_footers_to_appending_documents == other.apply_base_document_headers_and_footers_to_appending_documents &&
      document_entries == other.document_entries
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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 134

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 205

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 112

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

#collectFilesContent(resultFilesContent) ⇒ Object 



219
220
221
222
223
224
225
226
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 219

def collectFilesContent(resultFilesContent)
  if self.document_entries
      for element in self.document_entries do
          element.collectFilesContent(resultFilesContent);
      end
  end

end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


99
100
101
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 105

def hash
  [append_all_entries_to_one_section, apply_base_document_headers_and_footers_to_appending_documents, document_entries].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 185

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



191
192
193
194
195
196
197
198
199
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 191

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



179
180
181
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 179

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



83
84
85
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 83

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/aspose_words_cloud/models/document_entry_list.rb', line 228

def validate()
  raise ArgumentError, 'Property document_entries in DocumentEntryList is required.' if self.document_entries.nil?
  unless self.document_entries.nil?
      for elementDocumentEntries in self.document_entries
          unless elementDocumentEntries.nil?
              elementDocumentEntries.validate
          end
      end
  end

end