cycleManager

Documentation

Index

• type CycleManager
  • func New(db *dbManager.DbParameter, monit *statusManager.StatusManager, bp string) *CycleManager
  • func (m *CycleManager) CreateCycle(ctx context.Context, params cycle_management.CreateCycleParams) middleware.Responder
  • func (m *CycleManager) GetCycle(ctx context.Context, params cycle_management.GetCycleParams) middleware.Responder
  • func (m *CycleManager) ListCycles(ctx context.Context, params cycle_management.ListCyclesParams) middleware.Responder
  • func (m *CycleManager) UpdateCycle(ctx context.Context, params cycle_management.UpdateCycleParams) middleware.Responder

Types

type CycleManager

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

CycleManager is the struct defined to group and contain all the methods that interact with the cycle subsystem. Parameters: - basePath: a string with the base path of the system. - db: a DbParameter reference to be able to use the DBManager methods. - s.monit. a StatusManager reference to be able to use the status subsystem methods.

func New

func New(db *dbManager.DbParameter, monit *statusManager.StatusManager, bp string) *CycleManager

New is the function to create the struct CycleManager. Parameters: - DbParameter: reference pointing to the DbParameter that allows the interaction with the DBManager methods. - StatusParameter: reference poining to the StatusManager that allows the interaction with the StatusManager methods. - bp: a string containing the base path of the service. Returns: - CycleManager: struct to interact with CycleManager subsystem functionalities.

func (*CycleManager) CreateCycle

func (m *CycleManager) CreateCycle(ctx context.Context, params cycle_management.CreateCycleParams) middleware.Responder

CreateCycle (Swagger func) is the function behind the (POST) endpoint /cycle Its job is to add a new Cycle to the system.

func (*CycleManager) GetCycle

func (m *CycleManager) GetCycle(ctx context.Context, params cycle_management.GetCycleParams) middleware.Responder

GetCycle (Swagger func) is the function behind the (GET) endpoint /cycle/{id} Its job is to get the Cycle linked to the provided id.

func (*CycleManager) ListCycles

func (m *CycleManager) ListCycles(ctx context.Context, params cycle_management.ListCyclesParams) middleware.Responder

ListCycles (Swagger func) is the function behind the (GET) endpoint /cycle Its job is to get the list of Cycles in the system.

func (*CycleManager) UpdateCycle

func (m *CycleManager) UpdateCycle(ctx context.Context, params cycle_management.UpdateCycleParams) middleware.Responder

UpdateCycle (Swagger func) is the function behind the (PUT) endpoint /cycle/{id} Its job is to update the liked Cycle to the provided ID with the provided data.