organization

Documentation

Index

• type FilterOption
• type Service
  • func NewService(store Store) (*Service, error)
  • func (s *Service) Delete(ctx context.Context, id domain.OrganizationID) error
  • func (s *Service) Filter(ctx context.Context, filter ...domain.OrganizationFilter) ([]domain.Organization, error)
  • func (s *Service) Get(ctx context.Context, id domain.OrganizationID) (domain.Organization, error)
  • func (s *Service) Put(ctx context.Context, org domain.Organization) error
  • func (s *Service) Routes() chi.Router
  • func (s *Service) Shutdown(ctx context.Context) error
• type Store

Types

type FilterOption

type FilterOption struct {
	// OffSet is the start of the list where
	OffSet int
	Limit  int
	Org    domain.Organization
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service manages all interactions with domain.Organization Store

func NewService

func NewService(store Store) (*Service, error)

NewService creates an organization.Service. The organization.Store implementation is the storage backend for the service.

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, id domain.OrganizationID) error

Delete removes the domain.Organization from the Organization Store.

func (*Service) Filter

func (s *Service) Filter(ctx context.Context, filter ...domain.OrganizationFilter) ([]domain.Organization, error)

Filter returns a list of domain.Organization based on the filterOptions.

When the filterOptions are nil, the first 10 are returned.

func (*Service) Get

func (s *Service) Get(ctx context.Context, id domain.OrganizationID) (domain.Organization, error)

Get returns an domain.Organization and returns ErrOrgNotFound when the Organization is not found.

func (*Service) Put

func (s *Service) Put(ctx context.Context, org domain.Organization) error

Put stores an Organization in the Service Store.

func (*Service) Routes

func (s *Service) Routes() chi.Router

func (*Service) Shutdown

func (s *Service) Shutdown(ctx context.Context) error

Shutdown gracefully shutsdown the organization.Service store. The ctx should have a timeout that cancels when the deadline is exceeded.

type Store

type Store interface {
	Delete(ctx context.Context, id domain.OrganizationID) error
	Get(ctx context.Context, id domain.OrganizationID) (domain.Organization, error)
	Filter(ctx context.Context, filter ...domain.OrganizationFilter) ([]domain.Organization, error)
	Put(ctx context.Context, org domain.Organization) error
	Shutdown(ctx context.Context) error
}

Store is the storage interface for the organization.Service.