Class: UU::OS::UESURIBuilder

Inherits:
Object
  • Object
show all
Defined in:
uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb

Overview

Builder for creating UESURI.

Examples:

Usage:

uri = UESURIBuilder.set_territory_id('123').set_artifact_code('artCode').set_object_id('456').to_uesuri

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (UESURIBuilder) initialize

Creates new instance of UESURIBuilder.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 13

def initialize
  @role_id = nil
  @role_code = nil
  @territory_id = nil
  @territory_code = nil
  @artifact_id = nil
  @artifact_code = nil
  @object_id = nil
  @object_code = nil
  @use_case_id = nil
  @use_case_code = nil
  @parameters = nil
  @fragment = nil
end

Class Method Details

+ (UESURIBuilder) add_parameter(name, value)

Adds parameter for the new UESURI.

Parameters:

  • name (String)

    Parameter name

  • value (String)

    Parameter value

Returns:



285
286
287
288
289
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 285

def self.add_parameter(name, value)
  builder = UESURIBuilder.new
  builder.add_parameter(name, value)
  return builder
end

+ (UESURIBuilder) parse_uesuri(uesuri)

Parses specified string into UESURIBuilder instance.

Parameters:

Returns:



33
34
35
36
37
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 33

def self.parse_uesuri(uesuri)
  builder = UESURIBuilder.new
  builder.parse_uesuri(uesuri)
  return builder
end

+ (UESURIBuilder) set_artifact_code(artifact_code)

Sets artifact code for the new UESURI.

Parameters:

  • artifact_code (String)

    Artifact code

Returns:



171
172
173
174
175
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 171

def self.set_artifact_code(artifact_code)
  builder = UESURIBuilder.new
  builder.set_artifact_code(artifact_code)
  return builder
end

+ (UESURIBuilder) set_artifact_id(artifact_id)

Sets artifact ID for the new UESURI.

Parameters:

  • artifact_id (String)

    Artifact ID

Returns:



150
151
152
153
154
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 150

def self.set_artifact_id(artifact_id)
  builder = UESURIBuilder.new
  builder.set_artifact_id(artifact_id)
  return builder
end

+ (UESURIBuilder) set_fragment(fragment)

Sets fragment for the new UESURI.

Parameters:

  • fragment (String)

    Fragment

Returns:



310
311
312
313
314
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 310

def self.set_fragment(fragment)
  builder = UESURIBuilder.new
  builder.set_fragment(fragment)
  return builder
end

+ (UESURIBuilder) set_object_code(object_code)

Sets object code for the new UESURI.

Parameters:

  • object_code (String)

    Object code

Returns:



213
214
215
216
217
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 213

def self.set_object_code(object_code)
  builder = UESURIBuilder.new
  builder.set_object_code(object_code)
  return builder
end

+ (UESURIBuilder) set_object_id(object_id)

Sets object ID for the new UESURI.

Parameters:

  • object_id (String)

    Object ID

Returns:



192
193
194
195
196
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 192

def self.set_object_id(object_id)
  builder = UESURIBuilder.new
  builder.set_object_id(object_id)
  return builder
end

+ (UESURIBuilder) set_role_code(role_code)

Sets role code for the new UESURI.

Parameters:

  • role_code (String)

    Role code

Returns:



87
88
89
90
91
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 87

def self.set_role_code(role_code)
  builder = UESURIBuilder.new
  builder.set_role_code(role_code)
  return builder
end

+ (UESURIBuilder) set_role_id(role_id)

Sets role ID for the new UESURI.

Parameters:

  • role_id (String)

    Role ID

Returns:



66
67
68
69
70
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 66

def self.set_role_id(role_id)
  builder = UESURIBuilder.new
  builder.set_role_id(role_id)
  return builder
end

+ (UESURIBuilder) set_territory_code(territory_code)

Sets territory code for the new UESURI.

Parameters:

  • territory_code (String)

    Territory code

Returns:



129
130
131
132
133
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 129

def self.set_territory_code(territory_code)
  builder = UESURIBuilder.new
  builder.set_territory_code(territory_code)
  return builder
end

+ (UESURIBuilder) set_territory_id(territory_id)

Sets territory ID for the new UESURI.

Parameters:

  • territory_id (String)

    Territory ID

Returns:



108
109
110
111
112
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 108

def self.set_territory_id(territory_id)
  builder = UESURIBuilder.new
  builder.set_territory_id(territory_id)
  return builder
end

+ (UESURIBuilder) set_use_case_code(use_case_code)

Sets use case code for the new UESURI.

Parameters:

  • use_case_code (String)

    Use case code

Returns:



255
256
257
258
259
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 255

def self.set_use_case_code(use_case_code)
  builder = UESURIBuilder.new
  builder.set_use_case_code(use_case_code)
  return builder
end

+ (UESURIBuilder) set_use_case_id(use_case_id)

Sets use case ID for the new UESURI.

Parameters:

  • use_case_id (String)

    Use case ID

Returns:



234
235
236
237
238
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 234

def self.set_use_case_id(use_case_id)
  builder = UESURIBuilder.new
  builder.set_use_case_id(use_case_id)
  return builder
end

Instance Method Details

- (UESURIBuilder) add_parameter(name, value)

Adds parameter for the new UESURI.

Parameters:

  • name (String)

    Parameter name

  • value (String)

    Parameter value

Returns:



297
298
299
300
301
302
303
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 297

def add_parameter(name, value)
  if !@parameters
    @parameters = []
  end
  @parameters << UU::OS::UESURI::Parameter.new(name, value)
  return self
end

- (UESURIBuilder) clear_parameters

Clears any existing UESURI parameters.

Returns:



274
275
276
277
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 274

def clear_parameters
  @parameters = nil
  return self
end

- (UESURIBuilder) parse_uesuri(uesuri)

Parses specified string into UESURIBuilder instance.

Parameters:

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 44

def parse_uesuri(uesuri)
  uri = UU::OS::UESURI.new(uesuri)
  @role_id = uri.role_id
  @role_code = uri.role_code
  @territory_id = uri.territory_id
  @territory_code = uri.territory_code
  @artifact_id = uri.artifact_id
  @artifact_code = uri.artifact_code
  @object_id = uri.object_id
  @object_code = uri.object_code
  @use_case_id = uri.use_case_id
  @use_case_code = uri.use_case_code
  @parameters = uri.parameters
  @fragment = uri.fragment
  return self
end

- (UESURIBuilder) set_artifact_code(artifact_code)

Sets artifact code for the new UESURI.

Parameters:

  • artifact_code (String)

    Artifact code

Returns:



182
183
184
185
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 182

def set_artifact_code(artifact_code)
  @artifact_code = artifact_code
  return self
end

- (UESURIBuilder) set_artifact_id(artifact_id)

Sets artifact ID for the new UESURI.

Parameters:

  • artifact_id (String)

    Artifact ID

Returns:



161
162
163
164
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 161

def set_artifact_id(artifact_id)
  @artifact_id = artifact_id
  return self
end

- (UESURIBuilder) set_fragment(fragment)

Sets fragment for the new UESURI.

Parameters:

  • fragment (String)

    Fragment

Returns:



321
322
323
324
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 321

def set_fragment(fragment)
  @fragment = fragment
  return self
end

- (UESURIBuilder) set_object_code(object_code)

Sets object code for the new UESURI.

Parameters:

  • object_code (String)

    Object code

Returns:



224
225
226
227
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 224

def set_object_code(object_code)
  @object_code = object_code
  return self
end

- (UESURIBuilder) set_object_id(object_id)

Sets object ID for the new UESURI.

Parameters:

  • object_id (String)

    Object ID

Returns:



203
204
205
206
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 203

def set_object_id(object_id)
  @object_id = object_id
  return self
end

- (UESURIBuilder) set_role_code(role_code)

Sets role code for the new UESURI.

Parameters:

  • role_code (String)

    Role code

Returns:



98
99
100
101
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 98

def set_role_code(role_code)
  @role_code = role_code
  return self
end

- (UESURIBuilder) set_role_id(role_id)

Sets role ID for the new UESURI.

Parameters:

  • role_id (String)

    Role ID

Returns:



77
78
79
80
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 77

def set_role_id(role_id)
  @role_id = role_id
  return self
end

- (UESURIBuilder) set_territory_code(territory_code)

Sets territory code for the new UESURI.

Parameters:

  • territory_code (String)

    Territory code

Returns:



140
141
142
143
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 140

def set_territory_code(territory_code)
  @territory_code = territory_code
  return self
end

- (UESURIBuilder) set_territory_id(territory_id)

Sets territory ID for the new UESURI.

Parameters:

  • territory_id (String)

    Territory ID

Returns:



119
120
121
122
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 119

def set_territory_id(territory_id)
  @territory_id = territory_id
  return self
end

- (UESURIBuilder) set_use_case_code(use_case_code)

Sets use case code for the new UESURI.

Parameters:

  • use_case_code (String)

    Use case code

Returns:



266
267
268
269
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 266

def set_use_case_code(use_case_code)
  @use_case_code = use_case_code
  return self
end

- (UESURIBuilder) set_use_case_id(use_case_id)

Sets use case ID for the new UESURI.

Parameters:

  • use_case_id (String)

    Use case ID

Returns:



245
246
247
248
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 245

def set_use_case_id(use_case_id)
  @use_case_id = use_case_id
  return self
end

- (UU::OS::UESURI) to_uesuri

Creates new instance of UESURI.

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'uu_os_framework-0.10.6/lib/uu/os/uesuri_builder.rb', line 329

def to_uesuri
  if (!@territory_id) && (!@territory_code)
    raise 'Territory must be set in order to create valid UESURI.'
  end
  uri_string = 'ues:'
  if (@role_code) || (@role_id)
    uri_string << url_encode(@role_code.to_s) if @role_code
    uri_string << "[#{@role_id.to_s}]" if @role_id
    uri_string << '@'
  end
  if (@territory_code) || (@territory_id)
    uri_string << url_encode(@territory_code.to_s) if @territory_code
    uri_string << "[#{@territory_id.to_s}]" if @territory_id
  end
  if (@artifact_code) || (@artifact_id)
    uri_string << ':'
    uri_string << url_encode(@artifact_code.to_s) if @artifact_code
    uri_string << "[#{@artifact_id.to_s}]" if @artifact_id
  else
    uri_string << ':'
    uri_string << url_encode(@territory_code.to_s) if @territory_code
    uri_string << "[#{@territory_id.to_s}]" if @territory_id
  end
  if (@object_code) || (@object_id)
    uri_string << ':'
    uri_string << url_encode(@object_code.to_s) if @object_code
    uri_string << "[#{@object_id.to_s}]" if @object_id
  end
  if (@use_case_code) || (@use_case_id) || (@parameters)
    uri_string << '?'
    if (@use_case_code) || (@use_case_id)
      uri_string << url_encode(@use_case_code.to_s) if @use_case_code
      uri_string << "[#{@use_case_id.to_s}]" if @use_case_id
    end
    if (@parameters)
      @parameters.each do |parameter|
        uri_string << "&#{parameter}"
      end
    end
  end
  if (@fragment)
    uri_string << "##{url_encode(@fragment.to_s)}"
  end
  UU::OS::UESURI.new(uri_string)
end