ORE Studio 0.0.4
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
change_reasons_commands Class Reference

Manages commands related to change reasons. More...

#include <change_reasons_commands.hpp>

Collaboration diagram for change_reasons_commands:
Collaboration graph

Static Public Member Functions

static void register_commands (cli::Menu &root_menu, comms::net::client_session &session)
 Register change reason-related commands.
 
static void process_get_change_reasons (std::ostream &out, comms::net::client_session &session)
 Process a get change reasons request.
 
static void process_add_change_reason (std::ostream &out, comms::net::client_session &session, std::string code, std::string description, std::string category_code, std::string change_commentary)
 Process an add change reason request.
 
static void process_delete_change_reason (std::ostream &out, comms::net::client_session &session, std::string code)
 Process a delete change reason request.
 
static void process_get_change_reason_history (std::ostream &out, comms::net::client_session &session, std::string code)
 Process a get change reason history request.
 

Detailed Description

Manages commands related to change reasons.

Member Function Documentation

◆ register_commands()

void register_commands ( cli::Menu &  root_menu,
comms::net::client_session session 
)
static

Register change reason-related commands.

Creates the change-reasons submenu and adds operations.

◆ process_get_change_reasons()

void process_get_change_reasons ( std::ostream &  out,
comms::net::client_session session 
)
static

Process a get change reasons request.

Retrieves all change reasons from the server and displays them.

Parameters
outOutput stream for results
sessionClient session for connectivity.
Here is the caller graph for this function:

◆ process_add_change_reason()

void process_add_change_reason ( std::ostream &  out,
comms::net::client_session session,
std::string  code,
std::string  description,
std::string  category_code,
std::string  change_commentary 
)
static

Process an add change reason request.

Creates a new change reason with the provided details.

Parameters
outOutput stream for results
sessionClient session for connectivity.
codeUnique reason code (e.g., "static_data.correction")
descriptionHuman-readable description
category_codeCategory this reason belongs to
change_commentaryFree-text commentary explaining the change
Here is the caller graph for this function:

◆ process_delete_change_reason()

void process_delete_change_reason ( std::ostream &  out,
comms::net::client_session session,
std::string  code 
)
static

Process a delete change reason request.

Deletes a change reason by its code. Requires authentication.

Parameters
outOutput stream for results
sessionClient session for connectivity.
codeCode of the change reason to delete
Here is the caller graph for this function:

◆ process_get_change_reason_history()

void process_get_change_reason_history ( std::ostream &  out,
comms::net::client_session session,
std::string  code 
)
static

Process a get change reason history request.

Retrieves the version history for a change reason by its code.

Parameters
outOutput stream for results
sessionClient session for connectivity.
codeCode of the change reason
Here is the caller graph for this function: