View Javadoc
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.XmlEnum;
24  import javax.xml.bind.annotation.XmlEnumValue;
25  import javax.xml.bind.annotation.XmlType;
26  
27  
28  /**
29   * <p>Java class for completionStatus.
30   * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span style="font-family:Symbol">ยท<span style="font:7.0pt &quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
31  </span></span><b><i>completionStatus</i></b>: This optional argument lets the
32  publisher restrict the result set to only those relationships that have the
33  specified status value.&nbsp; Assertion status is a calculated result based on the
34  sum total of assertions made by the individuals that control specific business
35  registrations.&nbsp; When no completionStatus element is provided, all assertions
36  involving the businesses that the publisher owns are retrieved, without regard
37  to the completeness of the relationship.&nbsp; completionStatus MUST contain one of
38  the following values</p>
39  
40  <p class="MsoNormal" style="margin-left:1.5in;text-indent:-.25in"><span style="font-family:&quot;Courier New&quot;">o<span style="font:7.0pt &quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
41  </span></span><b>status:complete</b>: Passing this value causes only the
42  publisher assertions that are complete to be returned.&nbsp; Each businessEntity
43  listed in assertions that are complete has a visible relationship that directly
44  reflects the data in a complete assertion (as described in the
45  find_relatedBusinesses API).</p>
46  
47  <p class="MsoNormal" style="margin-left:1.5in;text-indent:-.25in"><span style="font-family:&quot;Courier New&quot;">o<span style="font:7.0pt &quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
48  </span></span><b>status:toKey_incomplete</b>: Passing this value causes only
49  those publisher assertions where the party who controls the businessEntity
50  referenced by the toKey value in an assertion, has not made a matching
51  assertion, to be listed.</p>
52  
53  <p class="MsoNormal" style="margin-left:1.5in;text-indent:-.25in"><span style="font-family:&quot;Courier New&quot;">o<span style="font:7.0pt &quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
54  </span></span><b>status:fromKey_incomplete</b>: Passing this value causes only
55  those publisher assertions where the party who controls the businessEntity
56  referenced by the fromKey value in an assertion, has not made a matching
57  assertion, to be listed.</p>
58  
59  <p class="MsoNormal" style="margin-left:1.5in;text-indent:-.25in"><span style="font-family:&quot;Courier New&quot;">o<span style="font:7.0pt &quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
60  </span></span><b>status:both_incomplete</b>. This status value, however, is only
61  applicable to the context of UDDI subscription and SHOULD not be present as
62  part of a response to a get_assertionStatusReport request.</p>  
63   * <p>The following schema fragment specifies the expected content contained within this class.
64   * <p>
65   * <pre>
66   * &lt;simpleType name="completionStatus">
67   *   &lt;restriction base="{http://www.w3.org/2001/XMLSchema}string">
68   *     &lt;maxLength value="32"/>
69   *     &lt;whiteSpace value="collapse"/>
70   *     &lt;enumeration value="status:complete"/>
71   *     &lt;enumeration value="status:fromKey_incomplete"/>
72   *     &lt;enumeration value="status:toKey_incomplete"/>
73   *     &lt;enumeration value="status:both_incomplete"/>
74   *   &lt;/restriction>
75   * &lt;/simpleType>
76   * </pre>
77   * 
78   */
79  @XmlType(name = "completionStatus")
80  @XmlEnum
81  public enum CompletionStatus implements Serializable{
82  
83      /**
84       * causes only the publisher assertions that are complete to be returned
85       */
86      @XmlEnumValue("status:complete")
87      STATUS_COMPLETE("status:complete"),
88      /**
89       * causes only those publisher assertions where the party who controls the businessEntity referenced by the fromKey value in an assertion, has not made a matching assertion, to be listed.
90       */
91      @XmlEnumValue("status:fromKey_incomplete")
92      STATUS_FROM_KEY_INCOMPLETE("status:fromKey_incomplete"),
93      /**
94       *  causes only those publisher assertions where the party who controls the businessEntity referenced by the toKey value in an assertion, has not made a matching assertion, to be listed.
95       */
96      @XmlEnumValue("status:toKey_incomplete")
97      STATUS_TO_KEY_INCOMPLETE("status:toKey_incomplete"),
98      /**
99       * only applicable to the context of UDDI subscription and SHOULD not be present as part of a response to a get_assertionStatusReport request.
100      *  When appearing in an assertionStatusItem of a subscriptionResultsList, status:both_incomplete indicates that the publisher assertion embedded in the <b>assertionStatusItem has been deleted from both ends. </b>
101      */
102     @XmlEnumValue("status:both_incomplete")
103     STATUS_BOTH_INCOMPLETE("status:both_incomplete");
104     private final String value;
105 
106     CompletionStatus(String v) {
107         value = v;
108     }
109 
110     public String value() {
111         return value;
112     }
113 
114     public static CompletionStatus fromValue(String v) {
115         for (CompletionStatus c: CompletionStatus.values()) {
116             if (c.value.equals(v)) {
117                 return c;
118             }
119         }
120         throw new IllegalArgumentException(v);
121     }
122 
123 }