Class: InventoryManagementAndItemManagementAndOrderManagementAndPriceManagement::SearchCriteria

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb

Overview

SearchCriteria Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(search_field = nil, search_value = nil) ⇒ SearchCriteria

Returns a new instance of SearchCriteria.



39
40
41
42
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 39

def initialize(search_field = nil, search_value = nil)
  @search_field = search_field
  @search_value = search_value
end

Instance Attribute Details

#search_field ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


15
16
17
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 15

def search_field
  @search_field
end

#search_value ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


19
20
21
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 19

def search_value
  @search_value
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 45

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  search_field = hash.key?('searchField') ? hash['searchField'] : nil
  search_value = hash.key?('searchValue') ? hash['searchValue'] : nil

  # Create object from extracted values.
  SearchCriteria.new(search_field,
                     search_value)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['search_field'] = 'searchField'
  @_hash['search_value'] = 'searchValue'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



35
36
37
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 35

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 30

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



64
65
66
67
68
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 64

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} search_field: #{@search_field.inspect}, search_value:"\
  " #{@search_value.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



58
59
60
61
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/search_criteria.rb', line 58

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} search_field: #{@search_field}, search_value: #{@search_value}>"
end