Class: RusticiSoftwareCloudV2::CreateRegistrationSchema
- Inherits:
-
Object
- Object
- RusticiSoftwareCloudV2::CreateRegistrationSchema
- Defined in:
- lib/rustici_software_cloud_v2/models/create_registration_schema.rb
Instance Attribute Summary collapse
-
#course_id ⇒ Object
Returns the value of attribute course_id.
-
#course_tags ⇒ Object
Returns the value of attribute course_tags.
-
#initial_registration_state ⇒ Object
Returns the value of attribute initial_registration_state.
-
#initial_settings ⇒ Object
Returns the value of attribute initial_settings.
-
#learner ⇒ Object
Returns the value of attribute learner.
-
#learner_tags ⇒ Object
Returns the value of attribute learner_tags.
-
#post_back ⇒ Object
Specifies an optional override URL for which to post activity and status data in real time as the course is completed.
-
#registration_id ⇒ Object
Returns the value of attribute registration_id.
-
#registration_tags ⇒ Object
Returns the value of attribute registration_tags.
-
#xapi_registration_id ⇒ Object
The xapiRegistrationId to be associated with this registration.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateRegistrationSchema
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ CreateRegistrationSchema
Initializes the object
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 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 73 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?(:'courseId') self.course_id = attributes[:'courseId'] end if attributes.has_key?(:'learner') self.learner = attributes[:'learner'] end if attributes.has_key?(:'registrationId') self.registration_id = attributes[:'registrationId'] end if attributes.has_key?(:'xapiRegistrationId') self.xapi_registration_id = attributes[:'xapiRegistrationId'] end if attributes.has_key?(:'learnerTags') if (value = attributes[:'learnerTags']).is_a?(Array) self. = value end end if attributes.has_key?(:'courseTags') if (value = attributes[:'courseTags']).is_a?(Array) self. = value end end if attributes.has_key?(:'registrationTags') if (value = attributes[:'registrationTags']).is_a?(Array) self. = value end end if attributes.has_key?(:'postBack') self.post_back = attributes[:'postBack'] end if attributes.has_key?(:'initialRegistrationState') self.initial_registration_state = attributes[:'initialRegistrationState'] end if attributes.has_key?(:'initialSettings') self.initial_settings = attributes[:'initialSettings'] end end |
Instance Attribute Details
#course_id ⇒ Object
Returns the value of attribute course_id.
17 18 19 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 17 def course_id @course_id end |
#course_tags ⇒ Object
Returns the value of attribute course_tags.
28 29 30 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 28 def @course_tags end |
#initial_registration_state ⇒ Object
Returns the value of attribute initial_registration_state.
35 36 37 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 35 def initial_registration_state @initial_registration_state end |
#initial_settings ⇒ Object
Returns the value of attribute initial_settings.
37 38 39 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 37 def initial_settings @initial_settings end |
#learner ⇒ Object
Returns the value of attribute learner.
19 20 21 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 19 def learner @learner end |
#learner_tags ⇒ Object
Returns the value of attribute learner_tags.
26 27 28 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 26 def @learner_tags end |
#post_back ⇒ Object
Specifies an optional override URL for which to post activity and status data in real time as the course is completed. By default all of these settings are read from your configuration.
33 34 35 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 33 def post_back @post_back end |
#registration_id ⇒ Object
Returns the value of attribute registration_id.
21 22 23 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 21 def registration_id @registration_id end |
#registration_tags ⇒ Object
Returns the value of attribute registration_tags.
30 31 32 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 30 def @registration_tags end |
#xapi_registration_id ⇒ Object
The xapiRegistrationId to be associated with this registration. If not specified, the system will assign an xapiRegistrationId. As per the xApi specification, this must be a UUID.
24 25 26 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 24 def xapi_registration_id @xapi_registration_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 40 def self.attribute_map { :'course_id' => :'courseId', :'learner' => :'learner', :'registration_id' => :'registrationId', :'xapi_registration_id' => :'xapiRegistrationId', :'learner_tags' => :'learnerTags', :'course_tags' => :'courseTags', :'registration_tags' => :'registrationTags', :'post_back' => :'postBack', :'initial_registration_state' => :'initialRegistrationState', :'initial_settings' => :'initialSettings' } end |
.swagger_types ⇒ Object
Attribute type mapping.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 56 def self.swagger_types { :'course_id' => :'String', :'learner' => :'LearnerSchema', :'registration_id' => :'String', :'xapi_registration_id' => :'String', :'learner_tags' => :'Array<String>', :'course_tags' => :'Array<String>', :'registration_tags' => :'Array<String>', :'post_back' => :'PostBackSchema', :'initial_registration_state' => :'RegistrationSchema', :'initial_settings' => :'SettingsPostSchema' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 157 def ==(o) return true if self.equal?(o) self.class == o.class && course_id == o.course_id && learner == o.learner && registration_id == o.registration_id && xapi_registration_id == o.xapi_registration_id && == o. && == o. && == o. && post_back == o.post_back && initial_registration_state == o.initial_registration_state && initial_settings == o.initial_settings end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 238 239 240 241 242 243 244 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 208 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 = RusticiSoftwareCloudV2.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
274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 274 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
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 187 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 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
174 175 176 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 174 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
180 181 182 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 180 def hash [course_id, learner, registration_id, xapi_registration_id, , , , post_back, initial_registration_state, initial_settings].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 128 def list_invalid_properties invalid_properties = Array.new if @course_id.nil? invalid_properties.push('invalid value for "course_id", course_id cannot be nil.') end if @learner.nil? invalid_properties.push('invalid value for "learner", learner cannot be nil.') end if @registration_id.nil? invalid_properties.push('invalid value for "registration_id", registration_id cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
254 255 256 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 254 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
260 261 262 263 264 265 266 267 268 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 260 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
248 249 250 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 248 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
147 148 149 150 151 152 |
# File 'lib/rustici_software_cloud_v2/models/create_registration_schema.rb', line 147 def valid? return false if @course_id.nil? return false if @learner.nil? return false if @registration_id.nil? true end |