1 /* 2 * Copyright 2001-2008 The Apache Software Foundation. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 * 16 */ 17 18 19 package org.uddi.api_v3; 20 21 import java.io.Serializable; 22 23 import javax.xml.bind.annotation.XmlAccessType; 24 import javax.xml.bind.annotation.XmlAccessorType; 25 import javax.xml.bind.annotation.XmlAttribute; 26 import javax.xml.bind.annotation.XmlTransient; 27 import javax.xml.bind.annotation.XmlType; 28 29 30 /** 31 * The find_tModel API is used to find UDDI tModel elements. The find_tModel API 32 * call returns a list of tModel entries that match a set of specific criteria. 33 * The response consists of summary information about registered tModel data 34 * returned in a tModelList structure. 35 *<Br><Br> 36 * · authInfo: This optional argument is an element that contains an 37 * authentication token. Registries that wish to restrict who can perform an 38 * inquiry in them typically require authInfo for this call. 39 *<Br><Br> 40 * · categoryBag: This is a list of category references. The returned tModelList 41 * contains tModelInfo elements whose associated tModels match all of the 42 * categories passed (logical AND by default). Specifying the appropriate 43 * findQualifiers can override this behavior. Matching rules for the use of 44 * keyedReferences and keyedReferenceGroups are described in Section 5.1.7 45 * Matching Rules for keyedReferences and keyedReferenceGroups. 46 *<Br><Br> 47 * · findQualifiers: This collection of findQualifier elements is used to alter 48 * the default behavior of search functionality. See Section 5.1.4 Find 49 * Qualifiers for more information. 50 *<Br><Br> 51 * · identifierBag This is a list of identifier references in the form of 52 * keyedReference elements. The returned tModelList contains tModelInfo elements 53 * whose associated tModels match any of the identifiers passed (logical OR by 54 * default). Specifying the appropriate findQualifiers can override this 55 * behavior. Matching rules are described in Section 5.1.7 Matching Rules for 56 * keyedReferences and keyedReferenceGroups. 57 *<Br><Br> 58 * · listHead: This optional integer value is used to indicate which item SHOULD 59 * be returned as the head of the list. The client may request a subset of the 60 * matching data by indicating which item in the resultant set constitutes the 61 * beginning of the returned data. The use of the listDescription element is 62 * mutually exclusive to the use of the truncated attribute that simply 63 * indicates a truncated result list in the Inquiry APIs. See Section 5.1.5 Use 64 * of listDescription, for a detailed description of the listHead argument. 65 *<Br><Br> 66 * · maxRows: This optional integer value allows the requesting program to limit 67 * the number of results returned. This argument can be used in conjunction with 68 * the listHead argument. 69 *<Br><Br> 70 * · name: This string value represents the name of the tModel elements to be 71 * found. Since tModel data only has a single name, only a single name may be 72 * passed. The argument must match exactly since "exactMatch" is the default 73 * behavior, but if the "approximateMatch" findQualifier is used together with 74 * the appropriate wildcard character, then matching is done according to 75 * wildcard rules. See Section 5.1.6 About Wildcards for additional information. 76 * The name MAY be marked with an xml:lang adornment. If a language markup is 77 * specified, the search results report a match only on those entries that match 78 * both the name value and language criteria. The match on language is a 79 * leftmost case-insensitive comparison of the characters supplied. This allows 80 * one to find all tModels whose name begins with an "A" and are expressed in 81 * any dialect of French, for example. Values which can be passed in the 82 * language criteria adornment MUST obey the rules governing the xml:lang data 83 * type as defined in Section 3.3.2.3 name.<Br><Br> 84 * <p>Java class for find_tModel complex type. 85 * 86 * <p>The following schema fragment specifies the expected content contained within this class. 87 * 88 * <pre> 89 * <complexType name="find_tModel"> 90 * <complexContent> 91 * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> 92 * <sequence> 93 * <element ref="{urn:uddi-org:api_v3}authInfo" minOccurs="0"/> 94 * <element ref="{urn:uddi-org:api_v3}findQualifiers" minOccurs="0"/> 95 * <element ref="{urn:uddi-org:api_v3}name" minOccurs="0"/> 96 * <element ref="{urn:uddi-org:api_v3}identifierBag" minOccurs="0"/> 97 * <element ref="{urn:uddi-org:api_v3}categoryBag" minOccurs="0"/> 98 * </sequence> 99 * <attribute name="maxRows" type="{http://www.w3.org/2001/XMLSchema}int" /> 100 * <attribute name="listHead" type="{http://www.w3.org/2001/XMLSchema}int" /> 101 * </restriction> 102 * </complexContent> 103 * </complexType> 104 * </pre> 105 * 106 * 107 */ 108 @XmlAccessorType(XmlAccessType.FIELD) 109 @XmlType(name = "find_tModel", propOrder = { 110 "authInfo", 111 "findQualifiers", 112 "name", 113 "identifierBag", 114 "categoryBag" 115 }) 116 public class FindTModel implements Serializable{ 117 @XmlTransient 118 private static final long serialVersionUID = -8389225501417978080L; 119 protected String authInfo; 120 protected FindQualifiers findQualifiers; 121 protected Name name; 122 protected IdentifierBag identifierBag; 123 protected CategoryBag categoryBag; 124 @XmlAttribute 125 protected Integer maxRows; 126 @XmlAttribute 127 protected Integer listHead; 128 129 /** 130 * Gets the value of the authInfo property. 131 * 132 * @return 133 * possible object is 134 * {@link String } 135 * 136 */ 137 public String getAuthInfo() { 138 return authInfo; 139 } 140 141 /** 142 * Sets the value of the authInfo property. 143 * 144 * @param value 145 * allowed object is 146 * {@link String } 147 * 148 */ 149 public void setAuthInfo(String value) { 150 this.authInfo = value; 151 } 152 153 /** 154 * Gets the value of the findQualifiers property. 155 * 156 * @return 157 * possible object is 158 * {@link FindQualifiers } 159 * 160 */ 161 public FindQualifiers getFindQualifiers() { 162 return findQualifiers; 163 } 164 165 /** 166 * Sets the value of the findQualifiers property. 167 * 168 * @param value 169 * allowed object is 170 * {@link FindQualifiers } 171 * 172 */ 173 public void setFindQualifiers(FindQualifiers value) { 174 this.findQualifiers = value; 175 } 176 177 /** 178 * Gets the value of the name property. 179 * 180 * @return 181 * possible object is 182 * {@link Name } 183 * 184 */ 185 public Name getName() { 186 return name; 187 } 188 189 /** 190 * Sets the value of the name property. 191 * 192 * @param value 193 * allowed object is 194 * {@link Name } 195 * 196 */ 197 public void setName(Name value) { 198 this.name = value; 199 } 200 201 /** 202 * Gets the value of the identifierBag property. 203 * 204 * @return 205 * possible object is 206 * {@link IdentifierBag } 207 * 208 */ 209 public IdentifierBag getIdentifierBag() { 210 return identifierBag; 211 } 212 213 /** 214 * Sets the value of the identifierBag property. 215 * 216 * @param value 217 * allowed object is 218 * {@link IdentifierBag } 219 * 220 */ 221 public void setIdentifierBag(IdentifierBag value) { 222 this.identifierBag = value; 223 } 224 225 /** 226 * Gets the value of the categoryBag property. 227 * 228 * @return 229 * possible object is 230 * {@link CategoryBag } 231 * 232 */ 233 public CategoryBag getCategoryBag() { 234 return categoryBag; 235 } 236 237 /** 238 * Sets the value of the categoryBag property. 239 * 240 * @param value 241 * allowed object is 242 * {@link CategoryBag } 243 * 244 */ 245 public void setCategoryBag(CategoryBag value) { 246 this.categoryBag = value; 247 } 248 249 /** 250 * Gets the value of the maxRows property. 251 * 252 * @return 253 * possible object is 254 * {@link Integer } 255 * 256 */ 257 public Integer getMaxRows() { 258 return maxRows; 259 } 260 261 /** 262 * Sets the value of the maxRows property. 263 * 264 * @param value 265 * allowed object is 266 * {@link Integer } 267 * 268 */ 269 public void setMaxRows(Integer value) { 270 this.maxRows = value; 271 } 272 273 /** 274 * Gets the value of the listHead property. 275 * 276 * @return 277 * possible object is 278 * {@link Integer } 279 * 280 */ 281 public Integer getListHead() { 282 return listHead; 283 } 284 285 /** 286 * Sets the value of the listHead property. 287 * 288 * @param value 289 * allowed object is 290 * {@link Integer } 291 * 292 */ 293 public void setListHead(Integer value) { 294 this.listHead = value; 295 } 296 297 }