001package org.hl7.fhir.r4.model.codesystems;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009  
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030*/
031
032// Generated on Thu, Dec 27, 2018 10:06-0500 for FHIR v4.0.0
033
034
035import org.hl7.fhir.exceptions.FHIRException;
036
037public enum GuideParameterCode {
038
039        /**
040         * 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.
041         */
042        APPLY, 
043        /**
044         * 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.
045         */
046        PATHRESOURCE, 
047        /**
048         * 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.
049         */
050        PATHPAGES, 
051        /**
052         * 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.
053         */
054        PATHTXCACHE, 
055        /**
056         * 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.
057         */
058        EXPANSIONPARAMETER, 
059        /**
060         * 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.
061         */
062        RULEBROKENLINKS, 
063        /**
064         * 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.
065         */
066        GENERATEXML, 
067        /**
068         * 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.
069         */
070        GENERATEJSON, 
071        /**
072         * 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.
073         */
074        GENERATETURTLE, 
075        /**
076         * 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).
077         */
078        HTMLTEMPLATE, 
079        /**
080         * added to help the parsers
081         */
082        NULL;
083        public static GuideParameterCode fromCode(String codeString) throws FHIRException {
084            if (codeString == null || "".equals(codeString))
085                return null;
086        if ("apply".equals(codeString))
087          return APPLY;
088        if ("path-resource".equals(codeString))
089          return PATHRESOURCE;
090        if ("path-pages".equals(codeString))
091          return PATHPAGES;
092        if ("path-tx-cache".equals(codeString))
093          return PATHTXCACHE;
094        if ("expansion-parameter".equals(codeString))
095          return EXPANSIONPARAMETER;
096        if ("rule-broken-links".equals(codeString))
097          return RULEBROKENLINKS;
098        if ("generate-xml".equals(codeString))
099          return GENERATEXML;
100        if ("generate-json".equals(codeString))
101          return GENERATEJSON;
102        if ("generate-turtle".equals(codeString))
103          return GENERATETURTLE;
104        if ("html-template".equals(codeString))
105          return HTMLTEMPLATE;
106        throw new FHIRException("Unknown GuideParameterCode code '"+codeString+"'");
107        }
108        public String toCode() {
109          switch (this) {
110            case APPLY: return "apply";
111            case PATHRESOURCE: return "path-resource";
112            case PATHPAGES: return "path-pages";
113            case PATHTXCACHE: return "path-tx-cache";
114            case EXPANSIONPARAMETER: return "expansion-parameter";
115            case RULEBROKENLINKS: return "rule-broken-links";
116            case GENERATEXML: return "generate-xml";
117            case GENERATEJSON: return "generate-json";
118            case GENERATETURTLE: return "generate-turtle";
119            case HTMLTEMPLATE: return "html-template";
120            default: return "?";
121          }
122        }
123        public String getSystem() {
124          return "http://hl7.org/fhir/guide-parameter-code";
125        }
126        public String getDefinition() {
127          switch (this) {
128            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.";
129            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.";
130            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.";
131            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.";
132            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.";
133            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.";
134            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.";
135            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.";
136            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.";
137            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).";
138            default: return "?";
139          }
140        }
141        public String getDisplay() {
142          switch (this) {
143            case APPLY: return "Apply Metadata Value";
144            case PATHRESOURCE: return "Resource Path";
145            case PATHPAGES: return "Pages Path";
146            case PATHTXCACHE: return "Terminology Cache Path";
147            case EXPANSIONPARAMETER: return "Expansion Profile";
148            case RULEBROKENLINKS: return "Broken Links Rule";
149            case GENERATEXML: return "Generate XML";
150            case GENERATEJSON: return "Generate JSON";
151            case GENERATETURTLE: return "Generate Turtle";
152            case HTMLTEMPLATE: return "HTML Template";
153            default: return "?";
154          }
155    }
156
157
158}
159