Support parameters in IDataPortal<>.Execute, IDataPortal<>.ExecuteAsync

[hoangcuongvn]

Actually IDataPortal<>.Execute and IDataPortal<>.ExecuteAsync does not support parameters. If I have to create a command class VerifyCredentialsCommand, it will be something like below:

public class VerifyCredentialsCommand : CommandBase<VerifyCredentialsCommand>
{
	public static readonly PropertyInfo<string> UserNameProperty = RegisterProperty<string>(x => x.UserName);
	public string UserName
	{
		get => ReadProperty(UserNameProperty);
		private set => LoadProperty(UserNameProperty, value);
	}

	public static readonly PropertyInfo<string> PasswordProperty = RegisterProperty<string>(x => x.Password);
	public string Password
	{
		get => ReadProperty(PasswordProperty);
		private set => LoadProperty(PasswordProperty, value);
	}

	public static readonly PropertyInfo<bool> OkProperty = RegisterProperty<bool>(x => x.Ok);
	public bool Ok
	{
		get => ReadProperty(OkProperty);
		private set => LoadProperty(OkProperty, value);
	}

	[Create]
	private void Create(string username, string password)
	{
		this.UserName = username;
		this.Password = password;
	}

	[Execute]
	private void Execute([Inject] DB db)
        {
           // Code here
        }
}

That means I have to create 2 properties UserName, Password and a Create method.

If IDataPortal<>.Execute, IDataPortal<>.ExecuteAsync support parameters (E.g T Execute(T obj, params object[] parameters)) the class VerifyCredentialsCommand would become much more compact. It no longer needs the UserName, Password properties and Create method. It will be simple and compact like below

public class VerifyCredentialsCommand : CommandBase<VerifyCredentialsCommand>
{
	public static readonly PropertyInfo<bool> OkProperty = RegisterProperty<bool>(x => x.Ok);
	public bool Ok
	{
		get => ReadProperty(OkProperty);
		private set => LoadProperty(OkProperty, value);
	}

	[Execute]
	private void Execute(string username, string password, [Inject] DB db)
        {
           // Code here
        }
}

The code to execute the command looks like below

public bool VerifyCredentials(string username, string password)
{
    var dp = _context.GetRequiredService<IDataPortal<VerifyCredentialsCommand>>()
    var cmd = dp.Execute(dp.Create(), username, password);
    return cmd.Ok;
}

[rockfordlhotka]

This is by design. A command object is a bi-directional construct that flows from the logical client to the logical server with information, acts on that information while on the logical server, then returns to the logical client with information.

You can use ReadOnlyBase if you want to create a construct that sends criteria to the logical server, acts on that criteria, and returns to the logical client with information. (based on a fetch operation)

These are both types of "command", just two different ways to support the concept.

[rockfordlhotka]

The command object, in the execute with parameters case, will flow back from the server to the client, yes. You could, of course, ignore the return value from the method, but the data portal will flow the data portal result from the server back to the client (which is how an exception would get back too).

[michaelcsikos]

So with var result = await portal.ExecuteAsync(1, 2, 3); we would no longer need to Create the command first? I like that.

[michaelcsikos]

This would also address CommandBase requires [Create] method? #2297

[rockfordlhotka]

Yes, for the execute with parameters scenario the domain object will be created on the server-side. It will literally work like an alias for fetch - but with a better name.

[hoangcuongvn]

I always love Execute, ExecuteAsync without having to create a command first 👍

[rockfordlhotka]

fwiw, this request is already on the backlog: #1775

[hoangcuongvn]

Is there any news on this feature (Execute with parameters)? If you worry about breaking prior Csla's design, just take a small step by only adding optional parameters to the IDataPortal.Execute and IDataPortal.ExecuteAsync. This small change would help us much.

public interface IDataPortal<T>
{
    ...
    Task<T> ExecuteAsync(T command, params object[] parameters);
    T Execute(T obj, params object[] parameters);
}

[rockfordlhotka]

I hope to get it into v6. 1.