001package org.hl7.fhir.r4.model.codesystems;
002
003
004
005
006/*
007  Copyright (c) 2011+, HL7, Inc.
008  All rights reserved.
009  
010  Redistribution and use in source and binary forms, with or without modification, 
011  are permitted provided that the following conditions are met:
012  
013   * Redistributions of source code must retain the above copyright notice, this 
014     list of conditions and the following disclaimer.
015   * Redistributions in binary form must reproduce the above copyright notice, 
016     this list of conditions and the following disclaimer in the documentation 
017     and/or other materials provided with the distribution.
018   * Neither the name of HL7 nor the names of its contributors may be used to 
019     endorse or promote products derived from this software without specific 
020     prior written permission.
021  
022  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
023  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
024  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
025  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
026  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
027  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
028  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
029  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
030  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
031  POSSIBILITY OF SUCH DAMAGE.
032  
033*/
034
035// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0
036
037
038import org.hl7.fhir.exceptions.FHIRException;
039
040public enum GuideParameterCode {
041
042        /**
043         * If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.
044         */
045        APPLY, 
046        /**
047         * The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type.
048         */
049        PATHRESOURCE, 
050        /**
051         * The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.
052         */
053        PATHPAGES, 
054        /**
055         * The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control.
056         */
057        PATHTXCACHE, 
058        /**
059         * The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT.
060         */
061        EXPANSIONPARAMETER, 
062        /**
063         * The value of this string 0..1 parameter is either "warning" or "error" (default = "error"). If the value is "warning" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.
064         */
065        RULEBROKENLINKS, 
066        /**
067         * The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML.
068         */
069        GENERATEXML, 
070        /**
071         * The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON.
072         */
073        GENERATEJSON, 
074        /**
075         * The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle.
076         */
077        GENERATETURTLE, 
078        /**
079         * The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).
080         */
081        HTMLTEMPLATE, 
082        /**
083         * added to help the parsers
084         */
085        NULL;
086        public static GuideParameterCode fromCode(String codeString) throws FHIRException {
087            if (codeString == null || "".equals(codeString))
088                return null;
089        if ("apply".equals(codeString))
090          return APPLY;
091        if ("path-resource".equals(codeString))
092          return PATHRESOURCE;
093        if ("path-pages".equals(codeString))
094          return PATHPAGES;
095        if ("path-tx-cache".equals(codeString))
096          return PATHTXCACHE;
097        if ("expansion-parameter".equals(codeString))
098          return EXPANSIONPARAMETER;
099        if ("rule-broken-links".equals(codeString))
100          return RULEBROKENLINKS;
101        if ("generate-xml".equals(codeString))
102          return GENERATEXML;
103        if ("generate-json".equals(codeString))
104          return GENERATEJSON;
105        if ("generate-turtle".equals(codeString))
106          return GENERATETURTLE;
107        if ("html-template".equals(codeString))
108          return HTMLTEMPLATE;
109        throw new FHIRException("Unknown GuideParameterCode code '"+codeString+"'");
110        }
111        public String toCode() {
112          switch (this) {
113            case APPLY: return "apply";
114            case PATHRESOURCE: return "path-resource";
115            case PATHPAGES: return "path-pages";
116            case PATHTXCACHE: return "path-tx-cache";
117            case EXPANSIONPARAMETER: return "expansion-parameter";
118            case RULEBROKENLINKS: return "rule-broken-links";
119            case GENERATEXML: return "generate-xml";
120            case GENERATEJSON: return "generate-json";
121            case GENERATETURTLE: return "generate-turtle";
122            case HTMLTEMPLATE: return "html-template";
123            case NULL: return null;
124            default: return "?";
125          }
126        }
127        public String getSystem() {
128          return "http://hl7.org/fhir/guide-parameter-code";
129        }
130        public String getDefinition() {
131          switch (this) {
132            case APPLY: return "If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.";
133            case PATHRESOURCE: return "The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type.";
134            case PATHPAGES: return "The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.";
135            case PATHTXCACHE: return "The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control.";
136            case EXPANSIONPARAMETER: return "The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT.";
137            case RULEBROKENLINKS: return "The value of this string 0..1 parameter is either \"warning\" or \"error\" (default = \"error\"). If the value is \"warning\" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.";
138            case GENERATEXML: return "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML.";
139            case GENERATEJSON: return "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON.";
140            case GENERATETURTLE: return "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle.";
141            case HTMLTEMPLATE: return "The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).";
142            case NULL: return null;
143            default: return "?";
144          }
145        }
146        public String getDisplay() {
147          switch (this) {
148            case APPLY: return "Apply Metadata Value";
149            case PATHRESOURCE: return "Resource Path";
150            case PATHPAGES: return "Pages Path";
151            case PATHTXCACHE: return "Terminology Cache Path";
152            case EXPANSIONPARAMETER: return "Expansion Profile";
153            case RULEBROKENLINKS: return "Broken Links Rule";
154            case GENERATEXML: return "Generate XML";
155            case GENERATEJSON: return "Generate JSON";
156            case GENERATETURTLE: return "Generate Turtle";
157            case HTMLTEMPLATE: return "HTML Template";
158            case NULL: return null;
159            default: return "?";
160          }
161    }
162
163
164}