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
• func MakeHandler(ctx context.Context, hs Service, logger kitlog.Logger) http.Handler
• type EventHandler
  • func NewEventHandler(s inspection.Service) EventHandler
• type Service
  • func NewLoggingService(logger log.Logger, s Service) Service
  • func NewService(r cargo.HandlingEventRepository, f cargo.HandlingEventFactory, h EventHandler) Service

Variables

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

ErrInvalidArgument is returned when one or more arguments are invalid.

Functions

func MakeHandler

func MakeHandler(ctx context.Context, hs Service, logger kitlog.Logger) http.Handler

MakeHandler ...

Types

type EventHandler

type EventHandler interface {
	CargoWasHandled(cargo.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(completionTime time.Time, trackingID cargo.TrackingID, voyageNumber voyage.Number,
		unLocode location.UNLocode, eventType cargo.HandlingEventType) error
}

Service provides handling operations.

func NewLoggingService

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

NewLoggingService ...

func NewService

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

NewService creates a handling event service with necessary dependencies.