Module: UU::OS::VisualUseCase

# Delete visual use case
UU::OS::VisualUseCase.delete('ues:TERRITORY:VISUAL_USE_CASE')

Parameters:

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

  URI of the VUC to be deleted.

# Start exporting a visual use case.
process_uri = UU::OS::VisualUseCase.export('ues:TERRITORY:VISUAL_USE_CASE')

# Wait for the end of the process.
export_uri = UU::OS::REST::Future.new(process_uri).get(nil, 600)

Parameters:

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

  URI of the visual use case to export.

Returns:

• (UU::OS::UESURI) —

  URI of the export process.

# Get visual use case attributes.
attributes = UU::OS::VisualUseCase.get_attributes('ues:TERRITORY:VISUAL_USE_CASE')

Parameters:

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

  URI of the VUC.

Returns:

• (VisualUseCaseAttributes) —

  Object containing the VUC attributes.

# Get visual use case data.
data = UU::OS::VisualUseCase.get_data('ues:TERRITORY:VISUAL_USE_CASE')

Parameters:

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

  URI of the VUC.

Returns:

• (UU::OS::REST::BinaryValue) —

  StreamHandler containing the data.

# Start exporting a visual use case
process_uri = UU::OS::VisualUseCase.export('ues:TERRITORY:VISUAL_USE_CASE')

# Wait for the end of the process.
export_uri = UU::OS::REST::Future.new(process_uri).get(nil, 600)

# Get exported XML file.
exported_data = UU::OS::VisualUseCase.get_export_data(export_uri, :requested_mime_type => 'application/xml')

Parameters:

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

  URI of the visual use case we want to get the exported XML file from.

• visual_use_case (UU::OS::VisualUseCase::VisualUseCaseGetExportData) (defaults to: nil) —

  Specific options.

Options Hash (visual_use_case):

• :requested_mime_type (String) —

  MIME type of the returned value. All possible MIME types can be found as constants in ExportMimeType class. ZIP is returned by default.

Returns:

• (UU::OS::REST::BinaryValue) —

  Data file of an exported visual use case (XML or ZIP containing XML).

# Get visual use case options.
UU::OS::VisualUseCase.get_options('ues:TERRITORY:VISUAL_USE_CASE')

Parameters:

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

  URI of the VUC.

• criteria (VisualUseCaseGetOptions) (defaults to: nil) —

  Object containing details for the operation.

Returns:

• (UU::OS::REST::BinaryValue) —

  StreamHandler containing the options.

# Get visual use case list.
UU::OS::VisualUseCase.get_use_case_list('ues:TERRITORY:VISUAL_USE_CASE')

#Get a list of visual use cases with name that starts with string Protocol.
UU::OS::VisualUseCase.get_use_case_list('ues:TERRITORY:VISUAL_USE_CASE', :query => "name='Protocol%'")

Parameters:

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

  URI of the VUC

• criteria (VisualUseCaseGetUseCaseList) (defaults to: nil) —

  Object containing criteria for listing connected use cases.

Options Hash (criteria):

• :query (String) —

  The UES query string. It has to conform the ues query syntax (see documentation for more info). Filtering and order of the result list can be specified there. If nil is set, no filtering is applied and entries are ordered by name of referenced artifact (and code and type as the second and the third criteria).

Returns:

• (UU::OS::REST::ResultList<VisualUseCase::VisualUseCaseGetUseCaseList, VisualUseCase::VisualUseCaseGetUseCaseListItem>) —

  List of the connected use cases

# Set visual use case attributes.
vucUri = UU::OS::VisualUseCase.set_attributes('ues:TERRITORY:VISUAL_USE_CASE', :description => 'Visual Use Case designated for testing purposes',
  :name => 'New Visual Use Case', :controller_engine => 'UXML_USECASE_2_0')

Parameters:

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

  URI of the VUC.

• criteria (VisualUseCaseSetAttributes) (defaults to: nil) —

  Object containing new attributes for given VUC.

Options Hash (criteria):

• :name (String) —

  The new name of the visual use case. If nil is set, the name is not modified.

• :code (String) —

  The new code of the visual use case. If nil is set, the code is not modified.

• :description (String) —

  The new description of the visual use case. If nil is set, the description is not modified.

• :security_level (String, UU::OS::Artifact::SecurityLevel) —

  Security level of the visual use case. If nil is set, the security level is not modified.

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

  URI of the visual use case icon. If nil is set, the icon is not modified. If nil URI (“ues:[-1]:[-1]:”) is set, the visual use case icon is removed and the visual use case uses icon from meta artifact. An example of icon URI: ‘ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{ART_077}’.

• :controller_url_path (String) —

  Path at which the controller will be deployed.

• :controller_class (String) —

  Class to look for when executing this VUC.

• :controller_engine (String, UU::OS::VisualUseCase::ControllerEngine) —

  Engine used for this VUC.

Returns:

• (UU::OS::UESURI) —

  URI of the changed VUC

# Set visual use case options.
UU::OS::VisualUseCase.set_options('ues:TERRITORY:VISUAL_USE_CASE', :data => "{\n    \"glossary\": {\n\"title\":\"example ě+ščřěščřžýáíé glossary\",\n\t\t\"GlossDiv\":{\n\"title\":\"S\",\n\t\t\t\"GlossList\":{\n\"GlossEntry\": {\n\"ID\":\"SGML\",\n\t\t\t\t\t\"SortAs\":\"SGML\",\n\t\t\t\t\t\"GlossTerm\":\"Standard Generalized Markup Language\",\n\t\t\t\t\t\"Acronym\":\"SGML\",\n\t\t\t\t\t\"Abbrev\":\"ISO 8879:1986\",\n\t\t\t\t\t\"GlossDef\":{\n\"para\":\"A meta-markup language, used to create markup languages such as DocBook.\",\n\t\t\t\t\t\t\"GlossSeeAlso\":[\"GML\",\"XML\"]\n},\n\t\t\t\t\t\"GlossSee\":\"markup\"\n}\n}\n}\n}\n}")

Parameters:

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

  VisualUseCase URI of the VUC.

• criteria (VisualUseCaseSetOptions) (defaults to: nil) —

  Object containing new options for the VUC.

Options Hash (criteria):

• :data (String, File, UU::OS::REST::BinaryValue) —

  Data for use case options. Only JSON (“application/json”) format is accepted.