Class UpdateFacilitySettingsCommand

Namespace

Core.CliniCore.Commands.Admin

Assembly

Core.CliniCore.dll

Represents a command that updates a specific setting for a facility.

public class UpdateFacilitySettingsCommand : AbstractCommand, ICommand

Inheritance

object

AbstractCommand

UpdateFacilitySettingsCommand

Implements

ICommand

Inherited Members

AbstractCommand._lastExecutionParameters

AbstractCommand._lastExecutionSession

AbstractCommand._previousState

AbstractCommand.CommandId

AbstractCommand.CommandName

AbstractCommand.CanUndo

AbstractCommand.Validate(CommandParameters, SessionContext)

AbstractCommand.Execute(CommandParameters, SessionContext)

AbstractCommand.Undo(SessionContext)

AbstractCommand.ValidateAuthorization(SessionContext)

AbstractCommand.ValidateSpecific(CommandParameters, SessionContext)

AbstractCommand.CaptureStateForUndo(CommandParameters, SessionContext)

AbstractCommand.UndoCore(object, SessionContext)

AbstractCommand.LogExecution(SessionContext)

AbstractCommand.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

The UpdateFacilitySettingsCommand is used to modify configuration settings for a facility identified by its unique ID. This command requires the facility ID, the name of the setting to update, and the new value for that setting as parameters. The required permission to execute this command is determined by the implementation of GetRequiredPermission().

Fields

Key

Represents the key used to identify the "update facility settings" operation in configuration or API contexts.

public const string Key = "updatefacilitysettings"

Field Value

string

Properties

CommandKey

Gets the unique key that identifies the command.

public override string CommandKey { get; }

Property Value

string

Description

Gets a textual description of the current object.

public override string Description { get; }

Property Value

string

Methods

ExecuteCore(CommandParameters, SessionContext?)

Executes the core logic for the command using the specified parameters and session context.

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

Parameters

parameters CommandParameters

The parameters that define the command to execute. Must not be null.

session SessionContext

The session context in which the command is executed, or null to execute without a session.

Returns

CommandResult

A CommandResult representing the outcome of the command execution.

Exceptions

NotImplementedException

GetRequiredPermission()

Returns the Permission required to access the associated resource or perform the operation.

public override Permission? GetRequiredPermission()

Returns

Permission?

The Permission required for access, or null if no specific permission is required.

Exceptions

NotImplementedException

ValidateParameters(CommandParameters)

Validates the specified command parameters and returns the result of the validation.

protected override CommandValidationResult ValidateParameters(CommandParameters parameters)

Parameters

parameters CommandParameters

The parameters to validate for the command. Cannot be null.

Returns

CommandValidationResult

A CommandValidationResult that indicates whether the parameters are valid and provides details about any validation errors.

Exceptions

NotImplementedException