51Degrees Common C/C++  4.1

A shared functionality library that is used by 51Degrees products

PropertyMetaData.hpp

1 /* *********************************************************************
2  * This Source Code Form is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
4  * Caversham, Reading, Berkshire, United Kingdom RG4 7BY
5  *
6  * This Source Code Form is subject to the terms of the Mozilla Public
7  * License, v. 2.0.
8  *
9  * If a copy of the MPL was not distributed with this file, You can obtain
10  * one at http://mozilla.org/MPL/2.0/.
11  *
12  * This Source Code Form is "Incompatible With Secondary Licenses", as
13  * defined by the Mozilla Public License, v. 2.0.
14  * ********************************************************************* */
15 
16 #ifndef FIFTYONE_DEGREES_PROPERTY_META_DATA_HPP
17 #define FIFTYONE_DEGREES_PROPERTY_META_DATA_HPP
18 
19 #include <string>
20 #include <vector>
21 #include "EntityMetaData.hpp"
22 
23 using namespace std;
24 
25 namespace FiftyoneDegrees {
26  namespace Common {
31  class PropertyMetaData : public EntityMetaData<string> {
32  public:
43 
51 
80  string name,
81  vector<string> dataFilesWherePresent,
82  string type,
83  string category,
84  string url,
85  bool available,
86  byte displayOrder,
87  bool isMandatory,
88  bool isList,
89  bool isObsolete,
90  bool show,
91  bool showValues,
92  string description,
93  string defaultValue,
94  byte componentId);
95 
106  string getName();
107 
113  vector<string> getDataFilesWherePresent();
114 
119  string getType();
120 
125  string getCategory();
126 
131  string getUrl();
132 
138  bool getAvailable();
139 
144  int getDisplayOrder();
145 
151  bool getIsMandatory();
152 
158  bool getIsList();
159 
165  bool getIsObsolete();
166 
171  bool getShow();
172 
178  bool getShowValues();
179 
184  string getDescription();
185 
192  string getDefaultValue();
193 
199  byte getComponentId();
200 
204  private:
206  vector<string> dataFilesWherePresent;
207 
209  string type;
210 
212  string category;
213 
215  string url;
216 
218  bool available;
219 
221  byte displayOrder;
222 
224  bool isMandatory;
225 
227  bool isList;
228 
230  bool isObsolete;
231 
233  bool show;
234 
236  bool showValues;
237 
239  string description;
240 
242  string defaultValue;
243 
245  byte componentId;
246  };
247  }
248 }
249 
250 #endif
51Degrees base namespace.
Definition: Collection.hpp:24
PropertyMetaData()
Default constructor, should not be used externally as it produces an invalid instance.
Definition: PropertyMetaData.hpp:42
Meta data relating to a property populated by an engine implementation.
Definition: PropertyMetaData.hpp:31
Base class for any entity meta data.
Definition: EntityMetaData.hpp:38