// Copyright (c) Cratis. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

import { Guid } from '@cratis/fundamentals';
import { ValidationResult } from '../validation/ValidationResult';

/**
 * Defines the result from executing commands.
 */
 export interface ICommandResult<TResponse = object> {
    /**
     * Gets the correlation identifier associated with the executed command.
     */
     readonly correlationId: Guid;

     /**
      * Gets whether or not the command executed successfully.
      */
     readonly isSuccess: boolean;

     /**
      * Gets whether or not the command was authorized to execute.
      */
     readonly isAuthorized: boolean;

     /**
      * Gets whether or not the command is valid.
      */
     readonly isValid: boolean;

     /**
      * Gets whether or not there are any exceptions that occurred.
      */
     readonly hasExceptions: boolean;

     /**
      * Gets any validation errors. If this collection is empty, there are errors.
      */
     readonly validationResults: ValidationResult[];

     /**
      * Gets any exception messages that might have occurred.
      */
     readonly exceptionMessages: string[];

     /**
      * Gets the stack trace if there was an exception.
      */
     readonly exceptionStackTrace: string;

    /**
     * Gets the response from the command, if any.
     */
     readonly response?: TResponse;
}