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

Manages commands related to change reason categories. More...

#include <change_reason_categories_commands.hpp>

Collaboration diagram for change_reason_categories_commands:
Collaboration graph

Static Public Member Functions

static void register_commands (cli::Menu &root_menu, comms::net::client_session &session)
 Register change reason category-related commands.
 
static void process_get_categories (std::ostream &out, comms::net::client_session &session)
 Process a get change reason categories request.
 
static void process_add_category (std::ostream &out, comms::net::client_session &session, std::string code, std::string description, std::string change_commentary)
 Process an add change reason category request.
 
static void process_delete_category (std::ostream &out, comms::net::client_session &session, std::string code)
 Process a delete change reason category request.
 
static void process_get_category_history (std::ostream &out, comms::net::client_session &session, std::string code)
 Process a get category history request.
 

Detailed Description

Manages commands related to change reason categories.

Member Function Documentation

◆ register_commands()

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

Register change reason category-related commands.

Creates the change-reason-categories submenu and adds operations.

◆ process_get_categories()

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

Process a get change reason categories request.

Retrieves all change reason categories from the server.

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

◆ process_add_category()

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

Process an add change reason category request.

Creates a new change reason category with the provided details.

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

◆ process_delete_category()

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

Process a delete change reason category request.

Deletes a category by its code. Requires authentication.

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

◆ process_get_category_history()

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

Process a get category history request.

Retrieves the version history for a category by its code.

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