Module: UU::OS::UseCaseLog

Extended by:
UseCaseLog
Included in:
UseCaseLog
Defined in:
uu_os_framework-0.29.16/lib/uu/os/use_case_log.rb,
uu_os_framework-0.29.16/lib/uu/os/use_case_log/use_case_log_type.rb,
uu_os_framework-0.29.16/lib/uu/os/use_case_log/use_case_log_level.rb,
uu_os_framework-0.29.16/lib/uu/os/use_case_log/use_case_log_add_record.rb,
uu_os_framework-0.29.16/lib/uu/os/use_case_log/use_case_log_get_record_list.rb,
uu_os_framework-0.29.16/lib/uu/os/use_case_log/use_case_log_get_record_entry.rb

Overview

Use Case Log service.

Defined Under Namespace

Classes: UseCaseLogAddRecord, UseCaseLogGetRecordList, UseCaseLogLevel, UseCaseLogRecordEntry, UseCaseLogType

Constant Summary

PATH =

Service path

'ues/platform/appl/UESUseCaseLog'

Instance Method Summary (collapse)

Instance Method Details

- (Object) add_record(territory_uri, log_record)

Adds a new record to the use case log.

Parameters:



18
19
20
21
22
23
24
# File 'uu_os_framework-0.29.16/lib/uu/os/use_case_log.rb', line 18

def add_record(territory_uri, log_record)
  svc = UU::OS::REST::RemoteClient.new(UseCaseLog)
  payload = UU::OS::UseCaseLog::UseCaseLogAddRecord.new(log_record).to_json();
  UU::OS::QoS::QoSHandler.auto_retry do
    svc.post('addRecord', territory_uri, payload)
  end
end

- (UU::OS::REST::ResultList<UseCaseLog::UseCaseLogGetRecordList, UseCaseLog::UseCaseLogRecordEntry>) get_record_list(artifact_uri, criteria = nil)

Returns a list of use case log records of an artifact.

Examples:

# Get record list for specified artifact without criteria.
UU::OS::UseCaseLog.get_record_list('ues:UNI:TESTARTIFACT')

# Get record list with parameters.
UU::OS::UseCaseLog.get_record_list('ues:UNI:TESTARTIFACT', :start_date=>'2017-01-01', :end_date=>'2017-01-10', :page_index=>0, :page_size=>10)

Parameters:

Returns:



39
40
41
42
43
44
45
46
47
# File 'uu_os_framework-0.29.16/lib/uu/os/use_case_log.rb', line 39

def get_record_list(artifact_uri, criteria = nil)
  svc = UU::OS::REST::RemoteClient.new(UseCaseLog, 'uu/os/UseCaseLog')
  dto = UU::OS::UseCaseLog::UseCaseLogGetRecordList.new(criteria).to_json()
  
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.post('getRecordList', artifact_uri, dto)
    return UU::OS::REST::ResultList.new(UseCaseLog::UseCaseLogGetRecordList, UseCaseLog::UseCaseLogRecordEntry, res)
  end
end