Module: UU::OS::UseCaseRealization Deprecated

Extended by:
UseCaseRealization
Included in:
UseCaseRealization
Defined in:
uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/controller_engine.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/use_case_realization_create.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/use_case_realization_attributes.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/use_case_realization_set_options.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/use_case_realization_get_options.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/use_case_realization_set_attributes.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/use_case_realization_get_use_case_list.rb,
uu_os_client-0.10.6/lib/uu/os/use_case_realization/use_case_realization_get_use_case_list_item.rb

Overview

Deprecated.

Use VisualUseCase instead.

Use Case Realization service.

Defined Under Namespace

Classes: ControllerEngine, UseCaseRealizationAttributes, UseCaseRealizationCreate, UseCaseRealizationGetOptions, UseCaseRealizationGetUseCaseList, UseCaseRealizationGetUseCaseListItem, UseCaseRealizationSetAttributes, UseCaseRealizationSetOptions

Constant Summary

PATH =

Service path

'/uu/os/UseCaseRealization'

Instance Method Summary (collapse)

Instance Method Details

- (UU::OS::UESURI) create(uri, dto = nil)

The command creates a use case realization in a specified location. At the very least meta artifact must be specified in UseCaseRealizationCreate DTO. Competent role for the new use case realization will be selected as the most suitable according to specified container and meta artifact (executive/authorized role with connected interface), or can be also specified in UseCaseRealizationCreate DTO.

Parameters:

  • uri (String, UU::OS::UESURI) —

    UESURI of the MetaModelDictionary where the UCR should be created

  • dto (UseCaseRealizationCreate) (defaults to: nil) —

    DTO containing attributes for the new UCR

Returns:



32
33
34
35
36
37
38
39
40
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 32

def create(uri, dto = nil)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  payload = UU::OS::UseCaseRealization::UseCaseRealizationCreate.new(dto).to_json                   

  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.post('create', uri, payload)
    return UU::OS::UESURI.new(res)
  end
end

- (Object) delete(uri)

The command deletes the specified use case realization from the system. The command fails when the specified use case realization is referenced by some use case.

Parameters:



46
47
48
49
50
51
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 46

def delete(uri)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  UU::OS::QoS::QoSHandler.auto_retry do
    svc.post('delete', uri)
  end
end

- (UseCaseRealizationAttributes) get_attributes(use_case_realization_uri)

This command returns attributes representing the use case realization specified by the useCaseRealizationUri parameter.

Parameters:

  • use_case_realization_uri (String, UU::OS::UESURI) —

    UESURI of the UCR

Returns:



58
59
60
61
62
63
64
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 58

def get_attributes(use_case_realization_uri)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.get('getAttributes', use_case_realization_uri)
    return UseCaseRealization::UseCaseRealizationAttributes.new(res)
  end
end

- (UU::OS::REST::BinaryValue) get_data(use_case_realization_uri)

Returns data of the first attachment on the UCR - supposed controller written in ruby

Parameters:

  • use_case_realization_uri (String, UU::OS::UESURI) —

    UESURI of the UCR

Returns:



88
89
90
91
92
93
94
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 88

def get_data(use_case_realization_uri)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.get('getData', use_case_realization_uri)
    return UU::OS::REST::BinaryValue.new(res, true)
  end
end

- (UU::OS::REST::BinaryValue) get_options(uri, dto = nil)

The command returns options of the specified use case.

Parameters:

Returns:



117
118
119
120
121
122
123
124
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 117

def get_options(uri, dto = nil)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  options = UU::OS::UseCaseRealization::UseCaseRealizationGetOptions.new(dto)
  svc.add_parameter('requestedMimeType', options.requested_mime_type)
  UU::OS::QoS::QoSHandler.auto_retry do
    return UU::OS::REST::BinaryValue.new(svc.get('getOptions', uri), true)
  end
end

- (UU::OS::REST::ResultList<UseCaseRealization::UseCaseRealizationGetUseCaseList, UseCaseRealization::UseCaseRealizationGetUseCaseListItem>) get_use_case_list(uri, criteria = nil)

Returns list of the use cases that are connected to the specified use case realization. The list of returned use cases could be filtered by the name or code. Returned list does not contain any objects filtered out by executed UESQuery. The list is sorted by the name (and codes in case are equal) of an use case by default.

See UESQuery Documentation.

Parameters:

Returns:



136
137
138
139
140
141
142
143
144
145
146
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 136

def get_use_case_list(uri, criteria=nil)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  dto = UseCaseRealization::UseCaseRealizationGetUseCaseList.new(criteria)
  svc.add_parameter('pageIndex', dto.page_index)
  svc.add_parameter('pageSize', dto.page_size)
  svc.add_parameter('query', dto.query)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.get('getUseCaseList', uri)
    return UU::OS::REST::ResultList.new(UseCaseRealization::UseCaseRealizationGetUseCaseList, UseCaseRealization::UseCaseRealizationGetUseCaseListItem, res)
  end
end

- (UU::OS::UESURI) set_attributes(uri, dto = nil)

The command for setting attributes of a specified use case realization. The command can't modify references to object like storage, competent role and so on.

Parameters:

Returns:



73
74
75
76
77
78
79
80
81
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 73

def set_attributes(uri, dto = nil)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  payload = UU::OS::UseCaseRealization::UseCaseRealizationSetAttributes.new(dto).to_json
  
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.post('setAttributes', uri, payload)
    return UU::OS::UESURI.new(res)
  end
end

- (Object) set_options(uri, dto = nil)

The command sets options of the specified use case realization.

Parameters:



101
102
103
104
105
106
107
108
109
 
# File 'uu_os_client-0.10.6/lib/uu/os/use_case_realization.rb', line 101

def set_options(uri, dto = nil)
  svc = UU::OS::REST::RemoteClient.new(UseCaseRealization)
  
  payload = UU::OS::UseCaseRealization::UseCaseRealizationSetOptions.new(dto).to_json                           
  
  UU::OS::QoS::QoSHandler.auto_retry do
    svc.post('setOptions', uri, payload)
  end
end