mapped_parameter.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** 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.
*/
 
/*
 * mapped_parameter.h
 *
 *  Created on: 7 Sep 2016
 *      Author: tyrrells
 */
 
#ifndef SERVER_SRC_SERVICES_LIB_INCLUDE_MAPPED_PARAMETER_H_
#define SERVER_SRC_SERVICES_LIB_INCLUDE_MAPPED_PARAMETER_H_
 
#include "jansson.h"
 
#include "grassroots_service_library.h"
 
#include "linked_list.h"
 
#include "parameter_set.h"
 
 
 
/* forward declarations */
struct ServiceJob;
 
 
typedef struct MappedParameter
{
  char *mp_input_param_s;
 
  char *mp_output_param_s;
 
 
  bool mp_required_flag;
 
 
  bool mp_multiple_flag;
} MappedParameter;
 
 
typedef struct MappedParameterNode
{
  ListItem mpn_node;
 
  MappedParameter *mpn_mapped_param_p;
} MappedParameterNode;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
GRASSROOTS_SERVICE_API MappedParameter *AllocateMappedParameter (const char *input_s, const char *output_s, bool required_flag, bool multi_flag);
 
 
GRASSROOTS_SERVICE_API MappedParameter *CreateMappedParameterFromJSON (const json_t *mapped_param_json_p);
 
 
GRASSROOTS_SERVICE_API void FreeMappedParameter (MappedParameter *mapped_param_p);
 
 
GRASSROOTS_SERVICE_API MappedParameterNode *AllocateMappedParameterNode (MappedParameter *mapped_param_p);
 
 
GRASSROOTS_SERVICE_API void FreeMappedParameterNode (ListItem *node_p);
 
 
GRASSROOTS_SERVICE_API bool SetMappedStringParameterValue (MappedParameter *mapped_param_p, ParameterSet *params_p, const char *param_name_s);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* SERVER_SRC_SERVICES_LIB_INCLUDE_MAPPED_PARAMETER_H_ */