Table of Contents

Class ListPatientsCommand

Namespace
Core.CliniCore.Commands.Profile
Assembly
Core.CliniCore.dll

Command that retrieves and displays a list of patient profiles. Supports filtering by assigned physician, search terms, and active/inactive status.

public class ListPatientsCommand : AbstractCommand, ICommand
Inheritance
ListPatientsCommand
Implements
Inherited Members

Constructors

ListPatientsCommand(ProfileService)

Constructs a ListPatientCommand, sourcing data from the provided ProfileService

public ListPatientsCommand(ProfileService profileService)

Parameters

profileService ProfileService

Exceptions

ArgumentNullException

Fields

Key

The unique key used to identify this command.

public const string Key = "listpatients"

Field Value

string

Properties

CanUndo

Whether this command can be undone - defaults to false

public override bool CanUndo { get; }

Property Value

bool

CommandKey

Unique key identifier for this command type Generated from the class name, converted to lowercase without "Command" suffix E.g., "LoginCommand" becomes "login", "CreatePatientCommand" becomes "createpatient"

public override string CommandKey { get; }

Property Value

string

Description

Description of what this command does

public override string Description { get; }

Property Value

string

Methods

ExecuteCore(CommandParameters, SessionContext?)

Executes the core command logic - must be implemented by derived classes

protected override CommandResult ExecuteCore(CommandParameters parameters, SessionContext? session)

Parameters

parameters CommandParameters
session SessionContext

Returns

CommandResult

GetRequiredPermission()

Gets the required permission to execute this command

public override Permission? GetRequiredPermission()

Returns

Permission?

ValidateParameters(CommandParameters)

Validates command parameters - override in derived classes

protected override CommandValidationResult ValidateParameters(CommandParameters parameters)

Parameters

parameters CommandParameters

The parameters to validate (never null, but may be empty)

Returns

CommandValidationResult

Validation result indicating success or failure with error messages