org.hyperledger.fabric.contract.routing.TxFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fabric-chaincode-shim Show documentation

Hyperledger Fabric Java Chaincode Shim

The newest version!

/*
 * Copyright 2019 IBM All Rights Reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.fabric.contract.routing;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.List;
import org.hyperledger.fabric.contract.ContractInterface;
import org.hyperledger.fabric.contract.metadata.TypeSchema;

public interface TxFunction {

    interface Routing {
        /**
         * Method to route calls to the transaction function.
         *
         * @return a method.
         */
        Method getMethod();

        /**
         * The associated contract class.
         *
         * @return a contract class.
         */
        Class getContractClass();

        /**
         * The associated contract instance.
         *
         * @return a contract.
         * @throws IllegalAccessException
         * @throws InstantiationException
         * @throws InvocationTargetException
         * @throws NoSuchMethodException
         */
        ContractInterface getContractInstance()
                throws IllegalAccessException, InstantiationException, InvocationTargetException, NoSuchMethodException;

        /**
         * Name of the serializer used for the transaction function.
         *
         * @return a serializer name.
         */
        String getSerializerName();
    }

    /** @return is this tx to be called when request fn is unknown */
    boolean isUnknownTx();

    /** @param unknown true if the transaction is to be called when the request fn is unknown; otherwise false. */
    void setUnknownTx(boolean unknown);

    /** @return Name */
    String getName();

    /** @return Routing object */
    Routing getRouting();

    /** @return Class of the return type */
    Class getReturnType();

    /** @return Parameter array */
    java.lang.reflect.Parameter[] getParameters();

    /** @return Submit or Evaluate */
    TransactionType getType();

    /** @param returnSchema */
    void setReturnSchema(TypeSchema returnSchema);

    /** @return TypeSchema of the return type */
    TypeSchema getReturnSchema();

    /** @param list */
    void setParameterDefinitions(List list);

    /** @return List of parameters */
    List getParamsList();
}