Class: CasemanagerClient::WorkflowTask

Inherits:
Object
  • Object
show all
Defined in:
lib/casemanager_client/models/workflow_task.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
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
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 65

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

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

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

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

  if attributes.has_key?(:'key_task')
    self.key_task = attributes[:'key_task']
  end

  if attributes.has_key?(:'started_at')
    self.started_at = attributes[:'started_at']
  end

  if attributes.has_key?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  end
end

Instance Attribute Details

#case_items ⇒ Object

Attributes of Case Items that are directly related to this workflow task.



23
24
25
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 23

def case_items
  @case_items
end

#completed_at ⇒ Object

When this task was completed



35
36
37
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 35

def completed_at
  @completed_at
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 17

def id
  @id
end

#key_task ⇒ Object

Is this task an important task in the workflow? Could be used when generating a visual timeline of the workflow.



29
30
31
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 29

def key_task
  @key_task
end

#name ⇒ Object

The name of the task. The logical operator tasks \“OR\” is also indicated by the name field. When a task is named \“OR\”, the task represents the \“OR\” logical operation for all parent tasks. This means that only one parent task is required to be completed before children tasks may be started.



20
21
22
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 20

def name
  @name
end

#parent_ids ⇒ Object

Other workflow tasks that come immediately before this task in the workflow. No parents IDs indicates this is the first task in a workflow. Workflows can branch and those branches can later rejoin. Multiple parent IDs indicate the rejoining of a branch. When multiple parent IDs are present, it defaults to AND logic. That means all parent task are required to be completed before this task may be started. When a task has a name of \“OR\” and has multiple parent IDs, it is specifying that only one of the parent tasks needs to be completed before children tasks may be started.



26
27
28
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 26

def parent_ids
  @parent_ids
end

#started_at ⇒ Object

When this task was started. If null, the task has not been started. If started_at has a value, and completed_at does not, the task is currently in progress



32
33
34
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 32

def started_at
  @started_at
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 38

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'case_items' => :'case_items',
    :'parent_ids' => :'parent_ids',
    :'key_task' => :'key_task',
    :'started_at' => :'started_at',
    :'completed_at' => :'completed_at'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 51

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'case_items' => :'Array<CaseItem>',
    :'parent_ids' => :'Array<Integer>',
    :'key_task' => :'BOOLEAN',
    :'started_at' => :'DateTime',
    :'completed_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      case_items == o.case_items &&
      parent_ids == o.parent_ids &&
      key_task == o.key_task &&
      started_at == o.started_at &&
      completed_at == o.completed_at
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



192
193
194
195
196
197
198
199
200
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
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 192

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 = CasemanagerClient.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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 258

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 171

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


158
159
160
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 158

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 164

def hash
  [id, name, case_items, parent_ids, key_task, started_at, completed_at].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 106

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @case_items.nil?
    invalid_properties.push('invalid value for "case_items", case_items cannot be nil.')
  end

  if @parent_ids.nil?
    invalid_properties.push('invalid value for "parent_ids", parent_ids cannot be nil.')
  end

  if @key_task.nil?
    invalid_properties.push('invalid value for "key_task", key_task cannot be nil.')
  end

  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



238
239
240
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 238

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 244

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



232
233
234
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 232

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



133
134
135
136
137
138
139
140
 
# File 'lib/casemanager_client/models/workflow_task.rb', line 133

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @case_items.nil?
  return false if @parent_ids.nil?
  return false if @key_task.nil?
  true
end