An interface for Commands, which are part of the Command design pattern. Each command wraps a method or function and allows to call them in uniform and safe manner. More...

Inheritance diagram for PipServices3.Commons.Commands.ICommand:

Public Member Functions
IList< ValidationResult >	Validate (Parameters args)
	Validates command arguments before execution using defined schema. More...

Public Member Functions inherited from PipServices3.Commons.Run.IExecutable
Task< object >	ExecuteAsync (string correlationId, Parameters args)
	Executes component with arguments and receives execution result. More...

Properties
string	Name `[get]`
	Gets the command name. More...

Schema	Schema `[get]`
	Gets the command schema. More...

Detailed Description

An interface for Commands, which are part of the Command design pattern. Each command wraps a method or function and allows to call them in uniform and safe manner.

See Command, IExecutable, ICommandInterceptor, InterceptedCommand

Member Function Documentation

◆ Validate()

IList<ValidationResult> PipServices3.Commons.Commands.ICommand.Validate ( Parameters args )

Validates command arguments before execution using defined schema.

Parameters

args	the parameters (arguments) to validate.

Returns: List of errors or empty list if validation was successful.

See Parameters, ValidationResult

Implemented in PipServices3.Commons.Commands.Command, and PipServices3.Commons.Commands.InterceptedCommand.

Property Documentation

◆ Name

string PipServices3.Commons.Commands.ICommand.Name

get

Gets the command name.

◆ Schema

Schema PipServices3.Commons.Commands.ICommand.Schema

get

Gets the command schema.

The documentation for this interface was generated from the following file:

src/Commands/ICommand.cs