Module: UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseSearch

Extended by:
ClientAccountBusinessCaseSearch
Included in:
ClientAccountBusinessCaseSearch
Defined in:
lib/uu/fairpay2/client_account_business_case_search.rb

Overview

Module Client Account Business Case. This service allows searching at Client Account Business Case(CABC).

Constant Summary

PATH =

Service path

'uu/fairpay2/businesscase/ClientAccountBusinessCaseSearch'

Instance Method Summary (collapse)

Instance Method Details

- (UU::OS::REST::ResultList<UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseSearchQuery, UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseAttributes>) query(territory_uri, criteria = nil)

Retrieves a result list of Client Account Business Cases for territory specified by main entity UESURI. The resulting attachment list is filtered according to the criteria provided by the criteria attribute.

authorizedPersons.

Examples:

# Territory URI, where we want to get Client Account Business Cases.
territory_uri = UU::OS::UESURI.new('ues:TERRITORY:TERRITORY');

# Get All Client Account Business Cases in territory.
UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseSearch.query(territory_uri,
 :query => "");
# Territory URI, where we want to get Client Account Business Cases.
territory_uri = UU::OS::UESURI.new('ues:TERRITORY:TERRITORY');

# Find Client Account Business Case by client_account_number
UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseSearch.query(territory_uri,
 :query => "clientAccountNumber = '12345'");
# Territory URI, where we want to get Client Account Business Cases.
territory_uri = UU::OS::UESURI.new('ues:TERRITORY:TERRITORY');

# Find Client Account Business Case where user with ID 1234-1 is authorized.
UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseSearch.query(territory_uri,
 :query => "authorizedPersons ~ '1234-1'");

Parameters:

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.

Returns:



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/uu/fairpay2/client_account_business_case_search.rb', line 56

def query(territory_uri, criteria = nil)
  svc = UU::OS::REST::RemoteClient.new(ClientAccountBusinessCaseSearch)
  dto = UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseSearchQuery.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('query', territory_uri)
    return UU::OS::REST::ResultList.new(UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseSearchQuery, UU::Fairpay2::BusinessCase::ClientAccountBusinessCaseAttributes, res)
  end
end