Class: UU::Finman::BusinessCase::BusinessCaseCreate

Inherits:
OS::REST::DTO
  • Object
show all
Defined in:
lib/uu/finman/businesscase/business_case_create.rb

Overview

Value object defining data required (available) for creating new Business Case entity.

Instance Attribute Summary (collapse)

Instance Attribute Details

- (UU::OS::UESURI) access_role_for_payments_uri

URI of access role for payments of interterritorial business case. If you try to set access role for payments on non interterriorial business case, the command will fail.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


68
69
70
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 68

def access_role_for_payments_uri
  @access_role_for_payments_uri
end

- (UU::OS::UESURI) business_case_company_uri

URI of company of created business case. Required attribute. When null is set, the create command will fail.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


50
51
52
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 50

def business_case_company_uri
  @business_case_company_uri
end

- (UU::Finman::BusinessCase::BusinessCaseType) business_case_type

Type of the business case.. Can be null, if the type of the business case is specified by attribute metaArtifactUri.

Parameters:

Returns:



144
145
146
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 144

def business_case_type
  @business_case_type
end

- (String) code

Code of created business case. Its value is automatically trimmed. The code must be unique in target territory. It cannot be empty string nor longer than 250 characters. The create command will fail otherwise. When null is set, the code is generated automatically.

Parameters:

  • (String)

Returns:

  • (String) 


29
30
31
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 29

def code
  @code
end

- (UU::OS::UESURI) competent_role_uri

URI of the role competent for created Business Case. When null is set, competent role will be taken from authorization.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


39
40
41
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 39

def competent_role_uri
  @competent_role_uri
end

- (UU::OS::UESURI) counterparty_business_case_uri

URI of counterparty business case of interterritorial business case. If you try to set counterparty business case on non interterriorial business case, the command will fail.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


62
63
64
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 62

def counterparty_business_case_uri
  @counterparty_business_case_uri
end

- (UU::OS::UESURI) credit_note_client_default_financial_category_uri

URI of default financial category of client's side of credit note.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


138
139
140
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 138

def credit_note_client_default_financial_category_uri
  @credit_note_client_default_financial_category_uri
end

- (UU::OS::UESURI) credit_note_supplier_default_financial_category_uri

URI of default financial category of supplier's side of credit note.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


133
134
135
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 133

def credit_note_supplier_default_financial_category_uri
  @credit_note_supplier_default_financial_category_uri
end

- (String) currency

Code of business case currency. Must be one from territory allowed reporting currencies.

Parameters:

  • (String)

Returns:

  • (String) 


44
45
46
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 44

def currency
  @currency
end

- (String) default_account_number

Default account number of the business case.

Parameters:

  • (String)

Returns:

  • (String) 


78
79
80
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 78

def 
  @default_account_number
end

- (UU::OS::UESURI) default_account_uri

URI of default account of the business case.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


73
74
75
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 73

def 
  @default_account_uri
end

- (String) description

Description of created Business Case.

Parameters:

  • (String)

Returns:

  • (String) 


34
35
36
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 34

def description
  @description
end

- (TrueClass, FalseClass) dry_run

Dry run. If true, all validations will be processed, but payment will not be created.

Parameters:

  • (TrueClass, FalseClass)

Returns:

  • (TrueClass, FalseClass) 


150
151
152
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 150

def dry_run
  @dry_run
end

- (UU::OS::UESURI) expost_payment_default_credit_financial_category_uri

URI of default financial category of credit side of ex-post payment.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


123
124
125
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 123

def expost_payment_default_credit_financial_category_uri
  @expost_payment_default_credit_financial_category_uri
end

- (UU::OS::UESURI) expost_payment_default_debit_financial_category_uri

URI of default financial category of debit side of ex-post payment.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


128
129
130
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 128

def expost_payment_default_debit_financial_category_uri
  @expost_payment_default_debit_financial_category_uri
end

- (UU::OS::UESURI) fast_payment_default_credit_financial_category_uri

URI of default financial category of credit side of fast payment.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


103
104
105
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 103

def fast_payment_default_credit_financial_category_uri
  @fast_payment_default_credit_financial_category_uri
end

- (UU::OS::UESURI) fast_payment_default_debit_financial_category_uri

URI of default financial category of debit side of fast payment.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


108
109
110
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 108

def fast_payment_default_debit_financial_category_uri
  @fast_payment_default_debit_financial_category_uri
end

- (UU::OS::UESURI) incoming_invoice_clerk_uri

URI of incoming invoice clerk's role.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


83
84
85
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 83

def incoming_invoice_clerk_uri
  @incoming_invoice_clerk_uri
end

- (UU::OS::UESURI) meta_artifact_uri

URI of meta artifact of created Business Case. Required attribute. When null is set or object referenced by the URI is not meta artifact of business case, create command will fail.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


14
15
16
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 14

def meta_artifact_uri
  @meta_artifact_uri
end

- (String) name

Name of created business case. Required attribute. Its value is automatically trimmed. Cannot be null nor empty string nor longer than 250 characters. The create command fails otherwise.

Parameters:

  • (String)

Returns:

  • (String) 


21
22
23
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 21

def name
  @name
end

- (UU::OS::UESURI) outgoing_invoice_clerk_uri

URI of outgoing invoice clerk's role.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


88
89
90
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 88

def outgoing_invoice_clerk_uri
  @outgoing_invoice_clerk_uri
end

- (UU::OS::UESURI) payment_default_credit_financial_category_uri

URI of default financial category of credit side of payment.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


93
94
95
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 93

def payment_default_credit_financial_category_uri
  @payment_default_credit_financial_category_uri
end

- (UU::OS::UESURI) payment_default_debit_financial_category_uri

URI of default financial category of debit side of payment.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


98
99
100
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 98

def payment_default_debit_financial_category_uri
  @payment_default_debit_financial_category_uri
end

- (UU::OS::UESURI) related_business_case_uri

URI of related business case of interterritorial business case. If you try to set related business case on non interterriorial business case, the command will fail.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


56
57
58
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 56

def related_business_case_uri
  @related_business_case_uri
end

- (UU::OS::UESURI) transfer_default_credit_financial_category_uri

URI of default financial category of credit side of financial transfer.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


113
114
115
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 113

def transfer_default_credit_financial_category_uri
  @transfer_default_credit_financial_category_uri
end

- (UU::OS::UESURI) transfer_default_debit_financial_category_uri

URI of default financial category of debit side of financial transfer.

Parameters:

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

Returns:

  • (UU::OS::UESURI) 


118
119
120
 
# File 'lib/uu/finman/businesscase/business_case_create.rb', line 118

def transfer_default_debit_financial_category_uri
  @transfer_default_debit_financial_category_uri
end