originatorFI.go

// Copyright 2020 The Moov Authors
// Use of this source code is governed by an Apache License
// license that can be found in the LICENSE file.

package wire

import (
	"encoding/json"
	"strings"
	"unicode/utf8"
)

// OriginatorFI is the originator Financial Institution
type OriginatorFI struct {
	// tag
	tag string
	// Financial Institution
	FinancialInstitution FinancialInstitution `json:"financialInstitution,omitempty"`

	// converters is composed for WIRE to GoLang Converters
	converters
}

// NewOriginatorFI returns a new OriginatorFI
func NewOriginatorFI() *OriginatorFI {
	ofi := &OriginatorFI{
		tag: TagOriginatorFI,
	}
	return ofi
}

// Parse takes the input string and parses the OriginatorFI values
//
// Parse provides no guarantee about all fields being filled in. Callers should make a Validate() call to confirm
// successful parsing and data validity.
func (ofi *OriginatorFI) Parse(record string) error {
	if utf8.RuneCountInString(record) < 6 {
		return NewTagMinLengthErr(6, len(record))
	}

	ofi.tag = record[:6]
	length := 6

	value, read, err := ofi.parseFixedStringField(record[length:], 1)
	if err != nil {
		return fieldError("IdentificationCode", err)
	}
	ofi.FinancialInstitution.IdentificationCode = value
	length += read

	value, read, err = ofi.parseVariableStringField(record[length:], 34)
	if err != nil {
		return fieldError("Identifier", err)
	}
	ofi.FinancialInstitution.Identifier = value
	length += read

	value, read, err = ofi.parseVariableStringField(record[length:], 35)
	if err != nil {
		return fieldError("Name", err)
	}
	ofi.FinancialInstitution.Name = value
	length += read

	value, read, err = ofi.parseVariableStringField(record[length:], 35)
	if err != nil {
		return fieldError("AddressLineOne", err)
	}
	ofi.FinancialInstitution.Address.AddressLineOne = value
	length += read

	value, read, err = ofi.parseVariableStringField(record[length:], 35)
	if err != nil {
		return fieldError("AddressLineTwo", err)
	}
	ofi.FinancialInstitution.Address.AddressLineTwo = value
	length += read

	value, read, err = ofi.parseVariableStringField(record[length:], 35)
	if err != nil {
		return fieldError("AddressLineThree", err)
	}
	ofi.FinancialInstitution.Address.AddressLineThree = value
	length += read

	if err := ofi.verifyDataWithReadLength(record, length); err != nil {
		return NewTagMaxLengthErr(err)
	}

	return nil
}

func (ofi *OriginatorFI) UnmarshalJSON(data []byte) error {
	type Alias OriginatorFI
	aux := struct {
		*Alias
	}{
		(*Alias)(ofi),
	}
	if err := json.Unmarshal(data, &aux); err != nil {
		return err
	}
	ofi.tag = TagOriginatorFI
	return nil
}

// String returns a fixed-width OriginatorFI record
func (ofi *OriginatorFI) String() string {
	return ofi.Format(FormatOptions{
		VariableLengthFields: false,
	})
}

// Format returns a OriginatorFI record formatted according to the FormatOptions
func (ofi *OriginatorFI) Format(options FormatOptions) string {
	var buf strings.Builder
	buf.Grow(181)
	buf.WriteString(ofi.tag)

	buf.WriteString(ofi.IdentificationCodeField())
	buf.WriteString(ofi.FormatIdentifier(options) + Delimiter)
	buf.WriteString(ofi.FormatName(options) + Delimiter)
	buf.WriteString(ofi.FormatAddressLineOne(options) + Delimiter)
	buf.WriteString(ofi.FormatAddressLineTwo(options) + Delimiter)
	buf.WriteString(ofi.FormatAddressLineThree(options) + Delimiter)

	if options.VariableLengthFields {
		return ofi.stripDelimiters(buf.String())
	} else {
		return buf.String()
	}
}

// Validate performs WIRE format rule checks on OriginatorFI and returns an error if not Validated
// The first error encountered is returned and stops that parsing.
// If ID Code is present, Identifier is mandatory and vice versa.
func (ofi *OriginatorFI) Validate() error {
	if ofi.tag != TagOriginatorFI {
		return fieldError("tag", ErrValidTagForType, ofi.tag)
	}

	if err := ofi.FinancialInstitution.Validate(); err != nil {
		return err
	}

	return nil
}

// IdentificationCodeField gets a string of the IdentificationCode field
func (ofi *OriginatorFI) IdentificationCodeField() string {
	return ofi.alphaField(ofi.FinancialInstitution.IdentificationCode, 1)
}

// IdentifierField gets a string of the Identifier field
func (ofi *OriginatorFI) IdentifierField() string {
	return ofi.alphaField(ofi.FinancialInstitution.Identifier, 34)
}

// NameField gets a string of the Name field
func (ofi *OriginatorFI) NameField() string {
	return ofi.alphaField(ofi.FinancialInstitution.Name, 35)
}

// AddressLineOneField gets a string of AddressLineOne field
func (ofi *OriginatorFI) AddressLineOneField() string {
	return ofi.alphaField(ofi.FinancialInstitution.Address.AddressLineOne, 35)
}

// AddressLineTwoField gets a string of AddressLineTwo field
func (ofi *OriginatorFI) AddressLineTwoField() string {
	return ofi.alphaField(ofi.FinancialInstitution.Address.AddressLineTwo, 35)
}

// AddressLineThreeField gets a string of AddressLineThree field
func (ofi *OriginatorFI) AddressLineThreeField() string {
	return ofi.alphaField(ofi.FinancialInstitution.Address.AddressLineThree, 35)
}

// FormatIdentificationCode returns FinancialInstitution.IdentificationCode formatted according to the FormatOptions
func (ofi *OriginatorFI) FormatIdentificationCode(options FormatOptions) string {
	return ofi.formatAlphaField(ofi.FinancialInstitution.IdentificationCode, 1, options)
}

// FormatIdentifier returns FinancialInstitution.Identifier formatted according to the FormatOptions
func (ofi *OriginatorFI) FormatIdentifier(options FormatOptions) string {
	return ofi.formatAlphaField(ofi.FinancialInstitution.Identifier, 34, options)
}

// FormatName returns FinancialInstitution.Name formatted according to the FormatOptions
func (ofi *OriginatorFI) FormatName(options FormatOptions) string {
	return ofi.formatAlphaField(ofi.FinancialInstitution.Name, 35, options)
}

// FormatAddressLineOne returns Address.AddressLineOne formatted according to the FormatOptions
func (ofi *OriginatorFI) FormatAddressLineOne(options FormatOptions) string {
	return ofi.formatAlphaField(ofi.FinancialInstitution.Address.AddressLineOne, 35, options)
}

// FormatAddressLineTwo returns Address.AddressLineTwo formatted according to the FormatOptions
func (ofi *OriginatorFI) FormatAddressLineTwo(options FormatOptions) string {
	return ofi.formatAlphaField(ofi.FinancialInstitution.Address.AddressLineTwo, 35, options)
}

// FormatAddressLineThree returns Address.AddressLineThree formatted according to the FormatOptions
func (ofi *OriginatorFI) FormatAddressLineThree(options FormatOptions) string {
	return ofi.formatAlphaField(ofi.FinancialInstitution.Address.AddressLineThree, 35, options)
}