service_metadata.h

Go to the documentation of this file.

/*
 ** Copyright 2014-2017 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.
 */
/*
 * service_metadata.h
 *
 *  Created on: 10 Nov 2017
 *      Author: billy
 */
 
#ifndef CORE_SHARED_SERVICES_INCLUDE_SERVICE_METADATA_H_
#define CORE_SHARED_SERVICES_INCLUDE_SERVICE_METADATA_H_
 
#include "grassroots_service_library.h"
#include "typedefs.h"
#include "schema_term.h"
 
#include "jansson.h"
 
 
 
 
typedef struct ServiceMetadata
{
  SchemaTerm *sm_application_category_p;
 
  SchemaTerm *sm_application_subcategory_p;
 
  LinkedList *sm_input_types_p;
 
  LinkedList *sm_output_types_p;
 
 
} ServiceMetadata;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_API ServiceMetadata *AllocateServiceMetadata (SchemaTerm *category_p, SchemaTerm *subcategory_p);
 
 
GRASSROOTS_SERVICE_API void FreeServiceMetadata (ServiceMetadata *metadata_p);
 
 
GRASSROOTS_SERVICE_API void ClearServiceMetadata (ServiceMetadata *metadata_p);
 
 
GRASSROOTS_SERVICE_API void SetServiceMetadataValues (ServiceMetadata *metadata_p, SchemaTerm *category_p, SchemaTerm *subcategory_p);
 
 
 
GRASSROOTS_SERVICE_API bool AddServiceMetadataToJSON (const ServiceMetadata *metadata_p, json_t *service_json_p);
 
 
GRASSROOTS_SERVICE_API bool AddSchemaTermToServiceMetadataInput (ServiceMetadata *metadata_p, SchemaTerm *term_p);
 
 
GRASSROOTS_SERVICE_API bool AddSchemaTermToServiceMetadataOutput (ServiceMetadata *metadata_p, SchemaTerm *term_p);
 
 
GRASSROOTS_SERVICE_API ServiceMetadata *GetServiceMetadataFromJSON (const json_t *service_json_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* CORE_SHARED_SERVICES_INCLUDE_SERVICE_METADATA_H_ */