/*
 *
 *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

/* $Rev$ $Date: 2005/12/22 11:33:21 $ */

#ifndef tuscany_sca_core_operation_h
#define tuscany_sca_core_operation_h
#include "osoa/sca/export.h"

#include <string>
using std::string;

namespace tuscany
{
    namespace sca
    {
        /**
         * Holds the details of a single invocation of a business method.
         * This class is used to pass the parameters and operation name from the
         * client to a service. It will also hold the return value on the 
         * return from the business method.
         */
        class Operation 
        {
        public:
            /**
             * Create a new operation.
             * @param operationName The method name of the business method to be invoked.
             * @param numParameters The number of parameters to be passed.
             */
            SCA_API Operation(const char* operationName, unsigned int numParameters);

            /**
             * Destructor.
             */
            SCA_API virtual    ~Operation();

            /**
             * Return the operation name.
             * @return The name of the operation.
             */
            SCA_API const char* getName() {return name;}

            /**
             * Set a parameter on the operation.
             * @param pos The position of the parameter in the parameter list.
             * @param parm Pointer to the parameter to be passed.
             */
            SCA_API void setParameter(unsigned int pos, void* parm);

            /**
             * Get a parameter from the operation.
             * @param pos The position of the parameter in the parameter list.
             * @return Pointer to the paramter at the given postion. Should be
             * cast to the appropriate type.
             */
            SCA_API void* getParameter(unsigned int pos);

            /**
             * Get the return value on the operation.
             * Normally the client
             * would set the return value and the service will get this
             * return value pointer and set the return value.
             * @return Pointer to the return type.
             */
            SCA_API void* getReturnValue() {return returnType;}

            /**
             * Set the return value on the operation.
             * Normally the client
             * would set the return value pointer so that the service can 
             * return a value
             * @param valPtr Pointer to the return type.
             */
            SCA_API void setReturnValue(void* valPtr);

        private:
            /**
             * Operation name (method name).
             */ 
            const char* name;

            /**
             * Number of paramaters passed for this operation.
             */ 
            unsigned int nparms;

            /**
             * Pointer to the array of parameters.
             */
            void** parameters;

            /**
             * The return value.
             */ 
            void* returnType;
        };
    } // End namespace sca
} // End namespace tuscany

#endif // tuscany_sca_core_operation_h