dividend

Documentation

Index

• type Finder
• type Persister
• type Status
• type StockDividend
  • func (d *StockDividend) TodayStatus() Status

Types

type Finder

type Finder interface {
	FindAllFormStock(stockID uuid.UUID) ([]StockDividend, error)
	// Find the next dividend announce or projected for the stock
	FindNextFromStock(stockID uuid.UUID, dt time.Time) (StockDividend, error)
	FindUpcoming(ID uuid.UUID) (StockDividend, error)
	FindAllDividendsFromThisYearOn(ID uuid.UUID, year int) ([]StockDividend, error)
	FindAllDividendsFromThisYearAndMontOn(ID uuid.UUID, year, month int) ([]StockDividend, error)
}

type Persister

type Persister interface {
	PersistAll(stockID uuid.UUID, ds []StockDividend) error
	DeleteAllFromStatus(stockID uuid.UUID, status Status) error
	DeleteAll(stockID uuid.UUID) error
}

type Status

type Status string

const (
	Projected Status = "projected"
	Announced Status = "announced"
	Payed     Status = "payed"
)

type StockDividend

type StockDividend struct {
	ExDate      time.Time
	PaymentDate time.Time
	RecordDate  time.Time

	Status Status

	Amount mm.Value

	ChangeFromPrev     float64
	ChangeFromPrevYear float64
	Prior12MonthsYield float64
}

func (*StockDividend) TodayStatus

func (d *StockDividend) TodayStatus() Status