View Javadoc
1   /*
2    * Copyright 2014 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  package org.apache.juddi.v3.client;
17  
18  /**
19   * UDDI v2 Constants, such as supported find qualifiers.<br><br> Taken from
20   * <a
21   * href="http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.htm#_Toc25137775">http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.htm#_Toc25137775</a>
22   *
23   * @author Alex O'Ree
24   */
25  public class UDDIv2Constants {
26  
27       /**
28        * signifies that lexical-order – i.e., leftmost in left-to-right languages
29        * – name match behavior should be overridden. When this behavior is
30        * specified, only entries that exactly match the entry passed in the name
31        * argument will be returned. Applies to: find_business, find_service, and
32        * find_tModel.
33        */
34       public static final String exactNameMatch = "exactNameMatch";
35       /**
36        * signifies that the default case-insensitive behavior of a name match
37        * should be overridden. When this behavior is specified, case is relevant
38        * in the search results and only entries that match the case of the value
39        * passed in the name argument will be returned. Applies to: find_business,
40        * find_service, and find_tModel.
41        */
42       public static final String caseSensitiveMatch = "caseSensitiveMatch";
43       /**
44        * signifies that the result returned by a find_xx inquiry call should be
45        * sorted on the name field in ascending alphabetic sort order. When there
46        * is more than one name field, the sort uses the first of them. This sort
47        * is applied prior to any truncation of result sets. Only applicable on
48        * queries that return a name element in the topmost detail level of the
49        * result set. If no conflicting sort qualifier is specified, this is the
50        * default sort order for inquiries that return name values at this topmost
51        * detail level. Applies to: find_business, find_relatedBusinesses,
52        * find_service, and find_tModel.
53        */
54       public static final String sortByNameAsc = "sortByNameAsc";
55       /**
56        * signifies that the result returned by a find_xx inquiry call should be
57        * sorted on the name field in descending alphabetic sort order. When there
58        * is more than one name field, the sort uses the first of them. This sort
59        * is applied prior to any truncation of result sets. Only applicable on
60        * queries that return a name element in the topmost detail level of the
61        * result set. This is the reverse of the default sort order for this kind
62        * of result. Applies to: find_business, find_relatedBusinesses,
63        * find_service, and find_tModel.
64        */
65       public static final String sortByNameDesc = "sortByNameDesc";
66       /**
67        * signifies that the result returned by a find_xx inquiry call should be
68        * sorted based on the date last updated in ascending chronological sort
69        * order (earliest returns first). If no conflicting sort qualifier is
70        * specified, this is the default sort order for all result sets. Applies
71        * to: find_binding, find_business, find_relatedBusinesses, find_service,
72        * and find_tModel.
73        */
74       public static final String sortByDateAsc = "sortByDateAsc";
75       /**
76        * signifies that the result returned by a find_xx inquiry call should be
77        * sorted based on the date last updated in descending chronological sort
78        * order (most recent change returns first). Sort qualifiers involving date
79        * are secondary in precedence to the sortByName qualifiers. This causes
80        * sortByName elements to be sorted within name by date, newest to oldest.
81        * Applies to: find_binding, find_business, find_relatedBusinesses,
82        * find_service, and find_tModel.
83        */
84       public static final String sortByDateDesc = "sortByDateDesc";
85       /**
86        * when a bag container contains multiple keyedReference elements (i.e.,
87        * categoryBag or identifierBag), any keyedReference filters that come from
88        * the same namespace (e.g. have the same tModelKey value) are OR’d
89        * together rather than AND’d. This allows one to say “any of these four
90        * values from this namespace, and any of these two values from this
91        * namespace”. Applies to: find_business, find_service, and find_tModel.
92        */
93       public static final String orLikeKeys = "orLikeKeys";
94       /**
95        * this changes the behavior for tModelBag and categoryBag to OR keys
96        * rather than AND them. This qualifier negates any AND treatment as well
97        * as the effect of orLikeKeys. Applies to: find_binding, find_business,
98        * find_service, and find_tModel.
99        */
100      public static final String orAllKeys = "orAllKeys";
101      /**
102       * this is only used in the find_business message. This qualifier makes the
103       * categoryBag entries for the full businessEntity element behave as though
104       * all categoryBag elements found at the businessEntity level and in all
105       * contained or referenced businessService elements were combined.
106       * Searching for a category will yield a positive match on a registered
107       * business if any of the categoryBag elements contained within the full
108       * businessEntity element (including the categoryBag elements within
109       * contained or referenced businessService elements) contains the filter
110       * criteria. Applies to: find_business.
111       */
112      public static final String combineCategoryBags = "combineCategoryBags";
113      /**
114       * this is used only in the find_business message. This qualifier is used
115       * in only in conjunction with a passed categoryBag argument and causes the
116       * component of the search that involves categorization to use only the
117       * categoryBag elements from contained or referenced businessService
118       * elements within the registered data, and ignores any entries found in
119       * the categoryBag direct descendent element of registered businessEntity
120       * elements. The resulting businessList message will return those
121       * businesses that matched based on this modified behavior, in conjunction
122       * with any other search arguments provided. Additionally, the contained
123       * serviceInfos elements will only reflect summary data (in a serviceInfo
124       * element) for those services (contained or referenced) that matched on
125       * one of the supplied categoryBag arguments. Applies to: find_business.
126       */
127      public static final String serviceSubset = "serviceSubset";
128      /**
129       * this changes the behavior for identifierBag to AND keys rather than OR
130       * them. Applies to: find_business and find_tModel.
131       */
132      public static final String andAllKeys = "andAllKeys";
133 }