# FWDProcedureMethodTestDescriptor.java

    /*
    ** Module   : FWDProcedureMethodTestDescriptor.java
    ** Abstract : Test descriptor for a legacy internal procedure.
    **
    ** Copyright (c) 2023-2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description---------------------------------
    ** 001 VVT 20230318 Created initial version.
    ** 002 VVT 20230428 Javadoc fixed.
    ** 003 VVT 20240321 Different procedure instances are now used in the test life-cycle. See #8406.
    ** 004 VVT 20240405 Partly reverted/fixed the previous change. See #8406-58, #8406-64.
    ** 005 VVT 20240405 NPE fixed (regression caused by the previous change). See #8406-82.
    ** 006 VVT 20240718 This class is now an ancestor of a class tree. See #8874.
    */
    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */
    package com.goldencode.p2j.testengine;

    import java.lang.reflect.*;
    import java.util.*;

    import com.goldencode.p2j.util.*;

    /**
     * Test descriptor for a legacy internal procedure.
     */
    public abstract class FWDProcedureMethodTestDescriptor
    extends AbstractMethodTestDescriptor
    {

       /**
        * Default constructor, required for de-serialization
        */
       public FWDProcedureMethodTestDescriptor()
       {
          // no-op
       }

       /**
        * Constructor.
        * <p>
        * The unique ID and display name for the descriptor are calculated based on
        * the parent descriptor ID and the method name.
        *
        * @param parent
        *        the parent descriptor
        * @param clazz
        *        the Java class to create instances
        * @param execute
        *        the method to execute
        * @param beforeEach
        *        methods to execute before the execute method
        * @param afterEach
        *        methods to execute after the execute method
        * @param expectedException
        *        if not {@code null}, the expected exception legacy class name
        */
       FWDProcedureMethodTestDescriptor(final AbstractClassTestDescriptor parent,
                                        final Class<?> clazz,
                                        final Method execute,
                                        final List<Method> beforeEach,
                                        final List<Method> afterEach,
                                        final String expectedException)
       {
          super(parent, clazz, execute, null, null, beforeEach, afterEach, expectedException);
       }

       /**
        * Execute a method.
        *
        * @param  m
        *         the method to execute
        * @param  o
        *         the object to use, can be {@code null} for "static" methods.
        * @param  args
        *         method call arguments, is not used for procedures
        *
        * @return always {@code null}
        */
       @Override
       protected BaseDataType callMethodImpl(final Method m,
                                             final Object o,
                                             final CallParameter[] args)
       {
          TestExecutionSupport.callProcedureMethod(m, (handle) o);
          return null;
       }

    }