mitkNodeQueryParams.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkNodeQueryParams_h
#define mitkNodeQueryParams_h
 
#include <optional>
#include <string>
#include <vector>
 
#include <MitkRESTAPIExports.h>
 
namespace mitk
{
  enum class Hierarchy
  {
    All,      
    Toplevel  
  };
 
  enum class PropertyScope
  {
    All,   
    Node,  
    Data   
  };
 
  struct MITKRESTAPI_EXPORT PropertyFilter
  {
    std::string key;               
    std::string value;             
    bool negated = false;          
  };
 
  struct MITKRESTAPI_EXPORT SortSpec
  {
    std::string field;             
    bool ascending = true;         
  };
 
  struct MITKRESTAPI_EXPORT NodeQueryParams
  {
    int limit = 50;    
    int offset = 0;    
 
    Hierarchy hierarchy = Hierarchy::All;  
 
    std::optional<std::string> path;       
    std::optional<std::string> dataType;   
    std::optional<std::string> parentUid;  
 
    std::vector<PropertyFilter> propertyFilters;  
 
    std::optional<std::string> context;    
    PropertyScope propertyScope = PropertyScope::All;  
 
    std::vector<std::string> fields;       
 
    std::optional<SortSpec> sort;          
  };
 
  struct MITKRESTAPI_EXPORT PropertyQueryParams
  {
    std::optional<std::string> context;    
    PropertyScope scope = PropertyScope::All;  
    bool includeContent = true;            
    std::vector<std::string> names;        
  };
}
 
#endif