handling

Documentation

Overview

Package handling provides the use-case for registering incidents. Used by views facing the people handling the cargo along its route.

Index

• Variables
• type EventHandler
  • func NewEventHandler(s inspection.Service) EventHandler
• type Service
  • func NewLoggingService(logger log.Logger, s Service) Service
  • func NewService(r shipping.HandlingEventRepository, f shipping.HandlingEventFactory, ...) Service

Variables

var ErrInvalidArgument = errors.New("invalid argument")

ErrInvalidArgument is returned when one or more arguments are invalid.

Types

type EventHandler

type EventHandler interface {
	CargoWasHandled(shipping.HandlingEvent)
}

EventHandler provides a means of subscribing to registered handling events.

func NewEventHandler

func NewEventHandler(s inspection.Service) EventHandler

NewEventHandler returns a new instance of a EventHandler.

type Service

type Service interface {
	// RegisterHandlingEvent registers a handling event in the system, and
	// notifies interested parties that a cargo has been handled.
	RegisterHandlingEvent(completed time.Time, id shipping.TrackingID, voyageNumber shipping.VoyageNumber,
		unLocode shipping.UNLocode, eventType shipping.HandlingEventType) (bool, error)
}

Service provides handling operations.

func NewLoggingService

func NewLoggingService(logger log.Logger, s Service) Service

NewLoggingService returns a new instance of a logging Service.

func NewService

func NewService(r shipping.HandlingEventRepository, f shipping.HandlingEventFactory, h EventHandler) Service

NewService creates a handling event service with necessary dependencies.