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