services

Documentation

Index

• Constants
• type EmployeeService
  • func NewEmployeeService() *EmployeeService
  • func (service *EmployeeService) DeleteEmployee(employeeID string) error
  • func (service *EmployeeService) GetEmployee(employeeID string) (models.Employee, error)
  • func (service *EmployeeService) ListAllEmployees() ([]models.Employee, error)
  • func (service *EmployeeService) PatchEmployeeDetails(employeeID string, employeeDetails models.Employee) error
  • func (service *EmployeeService) PostEmployee(employee models.Employee) (string, error)
  • func (service *EmployeeService) SearchEmployee(query string) ([]models.Employee, error)
• type EmployeeServiceIface

Constants

const CollectionName = "employee"

CollectionName is the table in mongoDB

const DbConnectionString = "mongodb://192.168.99.100:27017"

DbConnectionString should be read from environment

const DbName = "aicumendb"

DbName is the name of my DB in Mongo

Types

type EmployeeService

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

EmployeeService provides the implementation of EmployeeServiceIface

func NewEmployeeService

func NewEmployeeService() *EmployeeService

NewEmployeeService is the constructor for EmployeeService Struct

func (*EmployeeService) DeleteEmployee

func (service *EmployeeService) DeleteEmployee(employeeID string) error

DeleteEmployee deletes an employee permenantly from collection

func (*EmployeeService) GetEmployee

func (service *EmployeeService) GetEmployee(employeeID string) (models.Employee, error)

GetEmployee gets the employee details with the given employeeID

func (*EmployeeService) ListAllEmployees

func (service *EmployeeService) ListAllEmployees() ([]models.Employee, error)

ListAllEmployees list down all the employees from the DB

func (*EmployeeService) PatchEmployeeDetails

func (service *EmployeeService) PatchEmployeeDetails(employeeID string, employeeDetails models.Employee) error

PatchEmployeeDetails updates the employee details

func (*EmployeeService) PostEmployee

func (service *EmployeeService) PostEmployee(employee models.Employee) (string, error)

PostEmployee adds an employee to the DB

func (*EmployeeService) SearchEmployee

func (service *EmployeeService) SearchEmployee(query string) ([]models.Employee, error)

SearchEmployee lists down all the employees who match a search query

type EmployeeServiceIface

type EmployeeServiceIface interface {
	PostEmployee(employee models.Employee) (string, error)
	ListAllEmployees() ([]models.Employee, error)
	SearchEmployee(query string) ([]models.Employee, error)
	PatchEmployeeDetails(employeeID string, employeeDetails models.Employee) error
	GetEmployee(employeeID string) (models.Employee, error)
	DeleteEmployee(employeeID string) error
}

EmployeeServiceIface abstracts the methods for EmployeeService Implementation