schema_term.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.
 */
/*
 * schema_term.h
 *
 *  Created on: 14 Nov 2017
 *      Author: billy
 */
 
#ifndef CORE_SHARED_SERVICES_INCLUDE_SCHEMA_TERM_H_
#define CORE_SHARED_SERVICES_INCLUDE_SCHEMA_TERM_H_
 
 
#include "grassroots_service_library.h"
#include "linked_list.h"
 
#include "jansson.h"
 
typedef struct SchemaTerm
{
  char *st_url_s;
 
  char *st_name_s;
 
  char *st_description_s;
 
 
  char *st_abbreviation_s;
 
} SchemaTerm;
 
 
 
 
 
typedef struct SchemaTermNode
{
  ListItem stn_node;
 
  SchemaTerm *stn_term_p;
} SchemaTermNode;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_API SchemaTerm *AllocateExtendedSchemaTerm (const char *url_s, const char *name_s, const char *description_s, const char *abbreviation_s);
 
 
GRASSROOTS_SERVICE_API SchemaTerm *AllocateSchemaTerm (const char *url_s, const char *name_s, const char *description_s);
 
 
GRASSROOTS_SERVICE_API bool SetSchemaTermValues (SchemaTerm *term_p, const char *url_s, const char *name_s, const char *description_s);
 
 
 
GRASSROOTS_SERVICE_API bool DoSchemaTermsMatch (const SchemaTerm *term0_p, const SchemaTerm *term1_p);
 
 
 
GRASSROOTS_SERVICE_API void FreeSchemaTerm (SchemaTerm *term_p);
 
 
GRASSROOTS_SERVICE_API void ClearSchemaTerm (SchemaTerm *term_p);
 
 
GRASSROOTS_SERVICE_API SchemaTermNode *AllocateSchemaTermNodeByParts (const char *url_s, const char *name_s, const char *description_s);
 
 
GRASSROOTS_SERVICE_API SchemaTermNode *AllocateSchemaTermNode (SchemaTerm *term_p);
 
 
GRASSROOTS_SERVICE_API void FreeSchemaTermNode (ListItem *node_p);
 
 
GRASSROOTS_SERVICE_API json_t *GetSchemaTermAsJSON (const SchemaTerm *term_p);
 
 
GRASSROOTS_SERVICE_API bool AddSchemaTermToJSON (const SchemaTerm *term_p, json_t *root_p);
 
 
GRASSROOTS_SERVICE_API SchemaTerm *GetSchemaTermFromJSON (const json_t *term_json_p);
 
 
GRASSROOTS_SERVICE_API bool SetSchemaTermValues (SchemaTerm *term_p, const char *url_s, const char *name_s, const char *description_s);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* CORE_SHARED_SERVICES_INCLUDE_SCHEMA_TERM_H_ */