interfaces

Documentation

Index

• type Locations
• type Service
• type TTRPGSystems

Types

type Locations

type Locations interface {
	// CreateLocation creates location if no such exists
	CreateLocation(locations *models.Locations) (uint, error)

	// UpdateLocation updates location by its id
	UpdateLocation(id int, location requests.Update) error

	// GetLocation returns array of all available locations
	GetLocation(id int) (*models.Locations, error)

	// GetLocations returns array of locations
	GetLocations(page int, amount int) (*paginate.Pagination, error)

	// DeleteLocation return location by its id
	DeleteLocation(id int) error
}

type Service

type Service interface {
	// Health returns a map of health status information.
	// The keys and values in the map are service-specific.
	Health() map[string]string

	// Close terminates the database connection.
	// It returns an error if the connection cannot be closed.
	Close() error

	// DB exposes the GORM DB instance for application use.
	DB() *gorm.DB

	// Locations all interactions with locations table form db encapsulated here
	Locations

	// TTRPGSystems all interactions with ttrpg_systems table form db encapsulated here
	TTRPGSystems
}

type TTRPGSystems

type TTRPGSystems interface {
	// CreateTTRPGSystem creates a TTRPG system in the database.
	CreateTTRPGSystem(system *models.TTRPGSystems) (uint, error)

	// UpdateTTRPGSystem updates a TTRPG system in the database.
	UpdateTTRPGSystem(id int, system requests.Update) error

	// GetTTRPGSystem returns a TTRPG system from the database.
	GetTTRPGSystem(id int) (*models.TTRPGSystems, error)

	// GetTTRPGSystems returns a list of TTRPG systems from the database.
	GetTTRPGSystems(page int, amount int) (*paginate.Pagination, error)

	// DeleteTTRPGSystem deletes a TTRPG system from the database.
	DeleteTTRPGSystem(id int) error
}